Forms

Core

GET

List forms

/api/forms

List all forms in a workspace.

Filters

Provided via query string:

Name Type Description
id String ID
ownerId String Owning user's ID
workspaceId String Workspace ID
name String Name
status String Status

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.

GET

Get a form

/api/forms/{id}

Find a form by ID.

Response

A Form object.

Fields

GET

List fields

/api/forms/{id}/fields

List all fields in a form.

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 Field objects.

Groups

GET

List mapped groups

/api/forms/{id}/groups

List the groups a form is distributed to.

Parameters

Provided via query string:

Name Type Description
expand Boolean Include child 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.

Populations

GET

List population sets

/api/forms/{id}/populationSets

List all population sets for a form.

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 PopulationSet objects.

POST

Add a population set

/api/forms/{id}/populationSets

Add a population set to a form.

Request

Provided via body (as JSON):

Property Type Description
name String Name
published Boolean Published
tokens String[] Token names
populations Object[]

Population values

Each object is a map of a token name to a token value.

The following system tokens are available:
  • key (always required) - Used to identify a population
  • user - Restrict a population to a particular user (can be their e-mail address or IT username)

Example

{
    "name": "Example",
    "published": true,
    "tokens": ["key", "text", "choices"],
    "populations": [
        { "key": "First", "text": "Hello World", "choices": "a;b;c" },
        { "key": "Second", "text": "Goodbye World", "choices": "d;e;f" }
    ]
}

Response

A PopulationSet object.

GET

Get a population set

/api/forms/{id}/populationSets/{id}

Find a population set by ID.

Response

A PopulationSet object.

GET

List populations in a set

/api/forms/{id}/populationSets/{id}/populations

List all populations in a population set.

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 objects, where each is a map of a token name to a token value.

PATCH

Update a population set

/api/forms/{id}/populationSets/{id}

Update a population set.

Request

Provided via body (as JSON):

Property Type Description
published Boolean Published

Response

A PopulationSet object.

DELETE

Delete a population set

/api/forms/{id}/populationSets/{id}

Delete a population set.

Response

An empty 204.

Submissions

GET

List submissions

/api/forms/{id}/submissions

List submissions for a form.

Filters

Provided via query string:

Name Type Description
id String ID
userId String User's ID
email String User/participant's e-mail address
distribution String Distribution source

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 submission

/api/forms/{id}/submissions/{id}

Find a submssion by ID.

Response

A Submission object.

PATCH

Update a submission

/api/forms/{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 ""