Workflow API: Forms

Retrieves one specific form condition

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

maskedSurveyQuestionstring · uuidRequired

maskingSurveyOptionItemstring · uuidRequired

questionstringRequired

optionstringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/forms-conditions/{question}/{option}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/forms-conditions/{question}/{option} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "maskedSurveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "maskingSurveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Checks for the existence of one specific form condition

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

maskedSurveyQuestionstring · uuidRequired

maskingSurveyOptionItemstring · uuidRequired

questionstringRequired

optionstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workflow/forms-conditions/{question}/{option}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/forms-conditions/{question}/{option} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of form conditions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-conditions/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-conditions/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "maskedSurveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "maskingSurveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Counts the form conditions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-conditions/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-conditions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of form conditions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

No content

post

/api/workflow/forms-conditions/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-conditions/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of form conditions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-conditions/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-conditions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "maskedSurveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "maskingSurveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific form

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/forms/{form}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/forms/{form} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
  "displaySummaryChart": true,
  "enableUserConfidentiality": true,
  "hasWorkflowConfiguration": true,
  "requireUserAuthentication": true,
  "requireUserIdentification": true,
  "lastChangeType": "text",
  "surveyFormHook": "text",
  "surveyFormLanguage": "text",
  "surveyFormLanguageTranslations": "text",
  "surveyFormName": "text",
  "surveyFormStatus": "text",
  "userFeedback": "text",
  "assetNumber": 1,
  "branchCount": 1,
  "conditionCount": 1,
  "pageCount": 1,
  "questionCount": 1,
  "responseLimitPerUser": 1,
  "surveyFormDurationMinutes": 1,
  "lastChangeTime": "2026-01-22T14:48:24.502Z",
  "surveyFormClosed": "2026-01-22T14:48:24.502Z",
  "surveyFormLocked": "2026-01-22T14:48:24.502Z",
  "surveyFormOpened": "2026-01-22T14:48:24.502Z"
}

Checks for the existence of one specific form

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workflow/forms/{form}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/forms/{form} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

lastChangeUserstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyMessageInvitationstring · uuid | nullableOptional

surveyMessageResponseCompletedstring · uuid | nullableOptional

surveyMessageResponseConfirmedstring · uuid | nullableOptional

surveyMessageResponseStartedstring · uuid | nullableOptional

displaySummaryChartboolean | nullableOptional

enableUserConfidentialityboolean | nullableOptional

hasWorkflowConfigurationboolean | nullableOptional

requireUserAuthenticationboolean | nullableOptional

requireUserIdentificationboolean | nullableOptional

lastChangeTypestring | nullableOptional

surveyFormHookstring | nullableOptional

surveyFormLanguagestring | nullableOptional

surveyFormLanguageTranslationsstring | nullableOptional

surveyFormNamestring | nullableOptional

surveyFormStatusstring | nullableOptional

userFeedbackstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

branchCountinteger · int32 | nullableOptional

conditionCountinteger · int32 | nullableOptional

pageCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

responseLimitPerUserinteger · int32 | nullableOptional

surveyFormDurationMinutesinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

surveyFormClosedstring · date-time | nullableOptional

surveyFormLockedstring · date-time | nullableOptional

surveyFormOpenedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1505

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
  "displaySummaryChart": true,
  "enableUserConfidentiality": true,
  "hasWorkflowConfiguration": true,
  "requireUserAuthentication": true,
  "requireUserIdentification": true,
  "lastChangeType": "text",
  "surveyFormHook": "text",
  "surveyFormLanguage": "text",
  "surveyFormLanguageTranslations": "text",
  "surveyFormName": "text",
  "surveyFormStatus": "text",
  "userFeedback": "text",
  "assetNumber": 1,
  "branchCount": 1,
  "conditionCount": 1,
  "pageCount": 1,
  "questionCount": 1,
  "responseLimitPerUser": 1,
  "surveyFormDurationMinutes": 1,
  "lastChangeTime": "2026-01-22T14:48:24.502Z",
  "surveyFormClosed": "2026-01-22T14:48:24.502Z",
  "surveyFormLocked": "2026-01-22T14:48:24.502Z",
  "surveyFormOpened": "2026-01-22T14:48:24.502Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
    "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
    "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
    "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
    "displaySummaryChart": true,
    "enableUserConfidentiality": true,
    "hasWorkflowConfiguration": true,
    "requireUserAuthentication": true,
    "requireUserIdentification": true,
    "lastChangeType": "text",
    "surveyFormHook": "text",
    "surveyFormLanguage": "text",
    "surveyFormLanguageTranslations": "text",
    "surveyFormName": "text",
    "surveyFormStatus": "text",
    "userFeedback": "text",
    "assetNumber": 1,
    "branchCount": 1,
    "conditionCount": 1,
    "pageCount": 1,
    "questionCount": 1,
    "responseLimitPerUser": 1,
    "surveyFormDurationMinutes": 1,
    "lastChangeTime": "2026-01-22T14:48:24.502Z",
    "surveyFormClosed": "2026-01-22T14:48:24.502Z",
    "surveyFormLocked": "2026-01-22T14:48:24.502Z",
    "surveyFormOpened": "2026-01-22T14:48:24.502Z"
  }
]

Counts the forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

lastChangeUserstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyMessageInvitationstring · uuid | nullableOptional

surveyMessageResponseCompletedstring · uuid | nullableOptional

surveyMessageResponseConfirmedstring · uuid | nullableOptional

surveyMessageResponseStartedstring · uuid | nullableOptional

displaySummaryChartboolean | nullableOptional

enableUserConfidentialityboolean | nullableOptional

hasWorkflowConfigurationboolean | nullableOptional

requireUserAuthenticationboolean | nullableOptional

requireUserIdentificationboolean | nullableOptional

lastChangeTypestring | nullableOptional

surveyFormHookstring | nullableOptional

surveyFormLanguagestring | nullableOptional

surveyFormLanguageTranslationsstring | nullableOptional

surveyFormNamestring | nullableOptional

surveyFormStatusstring | nullableOptional

userFeedbackstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

branchCountinteger · int32 | nullableOptional

conditionCountinteger · int32 | nullableOptional

pageCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

responseLimitPerUserinteger · int32 | nullableOptional

surveyFormDurationMinutesinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

surveyFormClosedstring · date-time | nullableOptional

surveyFormLockedstring · date-time | nullableOptional

surveyFormOpenedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1505

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
  "displaySummaryChart": true,
  "enableUserConfidentiality": true,
  "hasWorkflowConfiguration": true,
  "requireUserAuthentication": true,
  "requireUserIdentification": true,
  "lastChangeType": "text",
  "surveyFormHook": "text",
  "surveyFormLanguage": "text",
  "surveyFormLanguageTranslations": "text",
  "surveyFormName": "text",
  "surveyFormStatus": "text",
  "userFeedback": "text",
  "assetNumber": 1,
  "branchCount": 1,
  "conditionCount": 1,
  "pageCount": 1,
  "questionCount": 1,
  "responseLimitPerUser": 1,
  "surveyFormDurationMinutes": 1,
  "lastChangeTime": "2026-01-22T14:48:24.502Z",
  "surveyFormClosed": "2026-01-22T14:48:24.502Z",
  "surveyFormLocked": "2026-01-22T14:48:24.502Z",
  "surveyFormOpened": "2026-01-22T14:48:24.502Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

lastChangeUserstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyMessageInvitationstring · uuid | nullableOptional

surveyMessageResponseCompletedstring · uuid | nullableOptional

surveyMessageResponseConfirmedstring · uuid | nullableOptional

surveyMessageResponseStartedstring · uuid | nullableOptional

displaySummaryChartboolean | nullableOptional

enableUserConfidentialityboolean | nullableOptional

hasWorkflowConfigurationboolean | nullableOptional

requireUserAuthenticationboolean | nullableOptional

requireUserIdentificationboolean | nullableOptional

lastChangeTypestring | nullableOptional

surveyFormHookstring | nullableOptional

surveyFormLanguagestring | nullableOptional

surveyFormLanguageTranslationsstring | nullableOptional

surveyFormNamestring | nullableOptional

surveyFormStatusstring | nullableOptional

userFeedbackstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

branchCountinteger · int32 | nullableOptional

conditionCountinteger · int32 | nullableOptional

pageCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

responseLimitPerUserinteger · int32 | nullableOptional

surveyFormDurationMinutesinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

surveyFormClosedstring · date-time | nullableOptional

surveyFormLockedstring · date-time | nullableOptional

surveyFormOpenedstring · date-time | nullableOptional

Responses

200

OK

No content

post

/api/workflow/forms/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1505

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
  "displaySummaryChart": true,
  "enableUserConfidentiality": true,
  "hasWorkflowConfiguration": true,
  "requireUserAuthentication": true,
  "requireUserIdentification": true,
  "lastChangeType": "text",
  "surveyFormHook": "text",
  "surveyFormLanguage": "text",
  "surveyFormLanguageTranslations": "text",
  "surveyFormName": "text",
  "surveyFormStatus": "text",
  "userFeedback": "text",
  "assetNumber": 1,
  "branchCount": 1,
  "conditionCount": 1,
  "pageCount": 1,
  "questionCount": 1,
  "responseLimitPerUser": 1,
  "surveyFormDurationMinutes": 1,
  "lastChangeTime": "2026-01-22T14:48:24.502Z",
  "surveyFormClosed": "2026-01-22T14:48:24.502Z",
  "surveyFormLocked": "2026-01-22T14:48:24.502Z",
  "surveyFormOpened": "2026-01-22T14:48:24.502Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

lastChangeUserstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyMessageInvitationstring · uuid | nullableOptional

surveyMessageResponseCompletedstring · uuid | nullableOptional

surveyMessageResponseConfirmedstring · uuid | nullableOptional

surveyMessageResponseStartedstring · uuid | nullableOptional

displaySummaryChartboolean | nullableOptional

enableUserConfidentialityboolean | nullableOptional

hasWorkflowConfigurationboolean | nullableOptional

requireUserAuthenticationboolean | nullableOptional

requireUserIdentificationboolean | nullableOptional

lastChangeTypestring | nullableOptional

surveyFormHookstring | nullableOptional

surveyFormLanguagestring | nullableOptional

surveyFormLanguageTranslationsstring | nullableOptional

surveyFormNamestring | nullableOptional

surveyFormStatusstring | nullableOptional

userFeedbackstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

branchCountinteger · int32 | nullableOptional

conditionCountinteger · int32 | nullableOptional

pageCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

responseLimitPerUserinteger · int32 | nullableOptional

surveyFormDurationMinutesinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

surveyFormClosedstring · date-time | nullableOptional

surveyFormLockedstring · date-time | nullableOptional

surveyFormOpenedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1505

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageInvitation": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseCompleted": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseConfirmed": "123e4567-e89b-12d3-a456-426614174000",
  "surveyMessageResponseStarted": "123e4567-e89b-12d3-a456-426614174000",
  "displaySummaryChart": true,
  "enableUserConfidentiality": true,
  "hasWorkflowConfiguration": true,
  "requireUserAuthentication": true,
  "requireUserIdentification": true,
  "lastChangeType": "text",
  "surveyFormHook": "text",
  "surveyFormLanguage": "text",
  "surveyFormLanguageTranslations": "text",
  "surveyFormName": "text",
  "surveyFormStatus": "text",
  "userFeedback": "text",
  "assetNumber": 1,
  "branchCount": 1,
  "conditionCount": 1,
  "pageCount": 1,
  "questionCount": 1,
  "responseLimitPerUser": 1,
  "surveyFormDurationMinutes": 1,
  "lastChangeTime": "2026-01-22T14:48:24.502Z",
  "surveyFormClosed": "2026-01-22T14:48:24.502Z",
  "surveyFormLocked": "2026-01-22T14:48:24.502Z",
  "surveyFormOpened": "2026-01-22T14:48:24.502Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific form option item

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyOptionItemstring · uuidRequired

itemstringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/forms-options-items/{item}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/forms-options-items/{item} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemCategory": "text",
  "surveyOptionItemSequence": 1,
  "surveyOptionItemPoints": 1
}

Checks for the existence of one specific form option item

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyOptionItemstring · uuidRequired

itemstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workflow/forms-options-items/{item}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/forms-options-items/{item} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of form option items that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

branchToQuestionIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyOptionListIdentifierstring · uuid | nullableOptional

surveyOptionItemCategorystring | nullableOptional

surveyOptionItemSequenceinteger · int32 | nullableOptional

surveyOptionItemPointsnumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-items/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-items/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 730

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemCategory": "text",
  "surveyOptionItemSequence": 1,
  "surveyOptionItemPoints": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyOptionItemCategory": "text",
    "surveyOptionItemSequence": 1,
    "surveyOptionItemPoints": 1
  }
]

Counts the form option items that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

branchToQuestionIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyOptionListIdentifierstring · uuid | nullableOptional

surveyOptionItemCategorystring | nullableOptional

surveyOptionItemSequenceinteger · int32 | nullableOptional

surveyOptionItemPointsnumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-items/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-items/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 730

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemCategory": "text",
  "surveyOptionItemSequence": 1,
  "surveyOptionItemPoints": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of form option items that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

branchToQuestionIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyOptionListIdentifierstring · uuid | nullableOptional

surveyOptionItemCategorystring | nullableOptional

surveyOptionItemSequenceinteger · int32 | nullableOptional

surveyOptionItemPointsnumber · double | nullableOptional

Responses

200

OK

No content

post

/api/workflow/forms-options-items/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-items/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 730

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemCategory": "text",
  "surveyOptionItemSequence": 1,
  "surveyOptionItemPoints": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of form option items that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

branchToQuestionIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyOptionListIdentifierstring · uuid | nullableOptional

surveyOptionItemCategorystring | nullableOptional

surveyOptionItemSequenceinteger · int32 | nullableOptional

surveyOptionItemPointsnumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-items/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-items/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 730

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "branchToQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionItemCategory": "text",
  "surveyOptionItemSequence": 1,
  "surveyOptionItemPoints": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "surveyOptionItemIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific form option list

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyOptionListstring · uuidRequired

liststringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/forms-options-lists/{list}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/forms-options-lists/{list} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListSequence": 1
}

Checks for the existence of one specific form option list

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyOptionListstring · uuidRequired

liststringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workflow/forms-options-lists/{list}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/forms-options-lists/{list} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of form option lists that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyQuestionIdentifierstring · uuid | nullableOptional

surveyOptionListSequenceinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-lists/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-lists/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 599

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListSequence": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyOptionListSequence": 1
  }
]

Counts the form option lists that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyQuestionIdentifierstring · uuid | nullableOptional

surveyOptionListSequenceinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-lists/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-lists/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 599

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListSequence": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of form option lists that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyQuestionIdentifierstring · uuid | nullableOptional

surveyOptionListSequenceinteger · int32 | nullableOptional

Responses

200

OK

No content

post

/api/workflow/forms-options-lists/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-lists/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 599

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListSequence": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of form option lists that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyQuestionIdentifierstring · uuid | nullableOptional

surveyOptionListSequenceinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-options-lists/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-options-lists/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 599

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyOptionListSequence": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "surveyOptionListIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific form question

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyQuestionstring · uuidRequired

questionstringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/forms-questions/{question}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/forms-questions/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIsNested": true,
  "surveyQuestionIsRequired": true,
  "surveyQuestionListEnableBranch": true,
  "surveyQuestionListEnableGroupMembership": true,
  "surveyQuestionListEnableOtherText": true,
  "surveyQuestionListEnableRandomization": true,
  "surveyQuestionNumberEnableStatistics": true,
  "surveyQuestionAttribute": "text",
  "surveyQuestionCode": "text",
  "surveyQuestionIndicator": "text",
  "surveyQuestionSource": "text",
  "surveyQuestionType": "text",
  "surveyQuestionSequence": 1,
  "surveyQuestionTextCharacterLimit": 1,
  "surveyQuestionTextLineCount": 1
}

Checks for the existence of one specific form question

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyQuestionstring · uuidRequired

questionstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workflow/forms-questions/{question}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/forms-questions/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of form questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyFormIdentifierstring · uuid | nullableOptional

surveyQuestionIsNestedboolean | nullableOptional

surveyQuestionIsRequiredboolean | nullableOptional

surveyQuestionListEnableBranchboolean | nullableOptional

surveyQuestionListEnableGroupMembershipboolean | nullableOptional

surveyQuestionListEnableOtherTextboolean | nullableOptional

surveyQuestionListEnableRandomizationboolean | nullableOptional

surveyQuestionNumberEnableStatisticsboolean | nullableOptional

surveyQuestionAttributestring | nullableOptional

surveyQuestionCodestring | nullableOptional

surveyQuestionIndicatorstring | nullableOptional

surveyQuestionSourcestring | nullableOptional

surveyQuestionTypestring | nullableOptional

surveyQuestionSequenceinteger · int32 | nullableOptional

surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional

surveyQuestionTextLineCountinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-questions/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-questions/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1091

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIsNested": true,
  "surveyQuestionIsRequired": true,
  "surveyQuestionListEnableBranch": true,
  "surveyQuestionListEnableGroupMembership": true,
  "surveyQuestionListEnableOtherText": true,
  "surveyQuestionListEnableRandomization": true,
  "surveyQuestionNumberEnableStatistics": true,
  "surveyQuestionAttribute": "text",
  "surveyQuestionCode": "text",
  "surveyQuestionIndicator": "text",
  "surveyQuestionSource": "text",
  "surveyQuestionType": "text",
  "surveyQuestionSequence": 1,
  "surveyQuestionTextCharacterLimit": 1,
  "surveyQuestionTextLineCount": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyQuestionIsNested": true,
    "surveyQuestionIsRequired": true,
    "surveyQuestionListEnableBranch": true,
    "surveyQuestionListEnableGroupMembership": true,
    "surveyQuestionListEnableOtherText": true,
    "surveyQuestionListEnableRandomization": true,
    "surveyQuestionNumberEnableStatistics": true,
    "surveyQuestionAttribute": "text",
    "surveyQuestionCode": "text",
    "surveyQuestionIndicator": "text",
    "surveyQuestionSource": "text",
    "surveyQuestionType": "text",
    "surveyQuestionSequence": 1,
    "surveyQuestionTextCharacterLimit": 1,
    "surveyQuestionTextLineCount": 1
  }
]

Counts the form questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyFormIdentifierstring · uuid | nullableOptional

surveyQuestionIsNestedboolean | nullableOptional

surveyQuestionIsRequiredboolean | nullableOptional

surveyQuestionListEnableBranchboolean | nullableOptional

surveyQuestionListEnableGroupMembershipboolean | nullableOptional

surveyQuestionListEnableOtherTextboolean | nullableOptional

surveyQuestionListEnableRandomizationboolean | nullableOptional

surveyQuestionNumberEnableStatisticsboolean | nullableOptional

surveyQuestionAttributestring | nullableOptional

surveyQuestionCodestring | nullableOptional

surveyQuestionIndicatorstring | nullableOptional

surveyQuestionSourcestring | nullableOptional

surveyQuestionTypestring | nullableOptional

surveyQuestionSequenceinteger · int32 | nullableOptional

surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional

surveyQuestionTextLineCountinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-questions/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-questions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1091

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIsNested": true,
  "surveyQuestionIsRequired": true,
  "surveyQuestionListEnableBranch": true,
  "surveyQuestionListEnableGroupMembership": true,
  "surveyQuestionListEnableOtherText": true,
  "surveyQuestionListEnableRandomization": true,
  "surveyQuestionNumberEnableStatistics": true,
  "surveyQuestionAttribute": "text",
  "surveyQuestionCode": "text",
  "surveyQuestionIndicator": "text",
  "surveyQuestionSource": "text",
  "surveyQuestionType": "text",
  "surveyQuestionSequence": 1,
  "surveyQuestionTextCharacterLimit": 1,
  "surveyQuestionTextLineCount": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of form questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyFormIdentifierstring · uuid | nullableOptional

surveyQuestionIsNestedboolean | nullableOptional

surveyQuestionIsRequiredboolean | nullableOptional

surveyQuestionListEnableBranchboolean | nullableOptional

surveyQuestionListEnableGroupMembershipboolean | nullableOptional

surveyQuestionListEnableOtherTextboolean | nullableOptional

surveyQuestionListEnableRandomizationboolean | nullableOptional

surveyQuestionNumberEnableStatisticsboolean | nullableOptional

surveyQuestionAttributestring | nullableOptional

surveyQuestionCodestring | nullableOptional

surveyQuestionIndicatorstring | nullableOptional

surveyQuestionSourcestring | nullableOptional

surveyQuestionTypestring | nullableOptional

surveyQuestionSequenceinteger · int32 | nullableOptional

surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional

surveyQuestionTextLineCountinteger · int32 | nullableOptional

Responses

200

OK

No content

post

/api/workflow/forms-questions/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-questions/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1091

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIsNested": true,
  "surveyQuestionIsRequired": true,
  "surveyQuestionListEnableBranch": true,
  "surveyQuestionListEnableGroupMembership": true,
  "surveyQuestionListEnableOtherText": true,
  "surveyQuestionListEnableRandomization": true,
  "surveyQuestionNumberEnableStatistics": true,
  "surveyQuestionAttribute": "text",
  "surveyQuestionCode": "text",
  "surveyQuestionIndicator": "text",
  "surveyQuestionSource": "text",
  "surveyQuestionType": "text",
  "surveyQuestionSequence": 1,
  "surveyQuestionTextCharacterLimit": 1,
  "surveyQuestionTextLineCount": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of form questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

surveyFormIdentifierstring · uuid | nullableOptional

surveyQuestionIsNestedboolean | nullableOptional

surveyQuestionIsRequiredboolean | nullableOptional

surveyQuestionListEnableBranchboolean | nullableOptional

surveyQuestionListEnableGroupMembershipboolean | nullableOptional

surveyQuestionListEnableOtherTextboolean | nullableOptional

surveyQuestionListEnableRandomizationboolean | nullableOptional

surveyQuestionNumberEnableStatisticsboolean | nullableOptional

surveyQuestionAttributestring | nullableOptional

surveyQuestionCodestring | nullableOptional

surveyQuestionIndicatorstring | nullableOptional

surveyQuestionSourcestring | nullableOptional

surveyQuestionTypestring | nullableOptional

surveyQuestionSequenceinteger · int32 | nullableOptional

surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional

surveyQuestionTextLineCountinteger · int32 | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflow/forms-questions/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/forms-questions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1091

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:48:24.502Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyQuestionIsNested": true,
  "surveyQuestionIsRequired": true,
  "surveyQuestionListEnableBranch": true,
  "surveyQuestionListEnableGroupMembership": true,
  "surveyQuestionListEnableOtherText": true,
  "surveyQuestionListEnableRandomization": true,
  "surveyQuestionNumberEnableStatistics": true,
  "surveyQuestionAttribute": "text",
  "surveyQuestionCode": "text",
  "surveyQuestionIndicator": "text",
  "surveyQuestionSource": "text",
  "surveyQuestionType": "text",
  "surveyQuestionSequence": 1,
  "surveyQuestionTextCharacterLimit": 1,
  "surveyQuestionTextLineCount": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "surveyQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]