Workflow API: Forms

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
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "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-29T17:47:05.464Z",
  "surveyFormClosed": "2026-01-29T17:47:05.464Z",
  "surveyFormLocked": "2026-01-29T17:47:05.464Z",
  "surveyFormOpened": "2026-01-29T17:47:05.464Z"
}

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
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

organizationIdstring · 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
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1497

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:05.464Z",
    "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",
  "organizationId": "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-29T17:47:05.464Z",
  "surveyFormClosed": "2026-01-29T17:47:05.464Z",
  "surveyFormLocked": "2026-01-29T17:47:05.464Z",
  "surveyFormOpened": "2026-01-29T17:47:05.464Z"
}

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

200

OK

[
  {
    "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "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-29T17:47:05.464Z",
    "surveyFormClosed": "2026-01-29T17:47:05.464Z",
    "surveyFormLocked": "2026-01-29T17:47:05.464Z",
    "surveyFormOpened": "2026-01-29T17:47:05.464Z"
  }
]

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

organizationIdstring · 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
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1497

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:05.464Z",
    "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",
  "organizationId": "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-29T17:47:05.464Z",
  "surveyFormClosed": "2026-01-29T17:47:05.464Z",
  "surveyFormLocked": "2026-01-29T17:47:05.464Z",
  "surveyFormOpened": "2026-01-29T17:47:05.464Z"
}

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

organizationIdstring · 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
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1497

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:05.464Z",
    "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",
  "organizationId": "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-29T17:47:05.464Z",
  "surveyFormClosed": "2026-01-29T17:47:05.464Z",
  "surveyFormLocked": "2026-01-29T17:47:05.464Z",
  "surveyFormOpened": "2026-01-29T17:47:05.464Z"
}

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

organizationIdstring · 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
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1497

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:47:05.464Z",
    "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",
  "organizationId": "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-29T17:47:05.464Z",
  "surveyFormClosed": "2026-01-29T17:47:05.464Z",
  "surveyFormLocked": "2026-01-29T17:47:05.464Z",
  "surveyFormOpened": "2026-01-29T17:47:05.464Z"
}

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

200

OK

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