Users

Core

GET

List users

/api/users

List all users.

Filters

Provided via query string:

Name Type Description
id String ID
name String Name
email String E-mail address

Parameters

Provided via query string:

Name Type Description
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of User objects.

GET

Get a user

/api/users/{id}

Find a user by ID.

Response

A User object.

Forms

GET

List forms available to a user

/api/users/{id}/forms

List all forms available to a user (via groups).

Filters

Provided via query string:

Name Type Description
workspaceId String Workspace ID

Parameters

Provided via query string:

Name Type Description
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of Form objects.

Groups

GET

List a user's group memberships

/api/users/{id}/groups

List all groups a user is a member of.

Filters

Provided via query string:

Name Type Description
workspaceId String Workspace ID

Parameters

Provided via query string:

Name Type Description
expand Boolean Include inherited parent groups (defaults to false)
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of Group objects.

Submissions

GET

List a user's submissions

/api/users/{id}/submissions

List all submissions made by a user.

Filters

Provided via query string:

Name Type Description
id String ID
formId String Form ID
workspaceId String Workspace ID

Parameters

Provided via query string:

Name Type Description
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of Submission objects.

GET

Get a user's submission

/api/users/{id}/submissions/{id}

Find a submission by ID.

Response

A Submission object.

PATCH

Update a user's submission

/api/users/{id}/submissions/{id}

Update a submission.

Parameters

Provided via query string:

Name Type Description
notifications Boolean Trigger form notifications
webhooks Boolean Trigger form webhooks
dataForwarding Boolean Trigger data forwarding

Request

Provided via body (as JSON):

Property Type Description
data Object

A patch object.

The existing data is only modified for entries included in the patch. To clear an entry, use a null value.

Note that data is only accepted for fields with the following data types:

  • Date
  • Number
  • String
  • Time
See the data property in the Submission definition for more details.

Response

A Submission object.

results matching ""

    No results matching ""