Workflows API: Forms

Retrieves one specific form

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

200

OK

application/jsontext/json

LastChangeUserstring · uuidOptional

SurveyFormIdstring · uuidOptional

SurveyMessageInvitationstring · uuid · nullableOptional

SurveyMessageResponseCompletedstring · uuid · nullableOptional

SurveyMessageResponseConfirmedstring · uuid · nullableOptional

SurveyMessageResponseStartedstring · uuid · nullableOptional

DisplaySummaryChartbooleanOptional

EnableUserConfidentialitybooleanOptional

HasWorkflowConfigurationbooleanOptional

RequireUserAuthenticationbooleanOptional

RequireUserIdentificationbooleanOptional

LastChangeTypestring · nullableOptional

SurveyFormHookstring · nullableOptional

SurveyFormLanguagestring · nullableOptional

SurveyFormLanguageTranslationsstring · nullableOptional

SurveyFormNamestring · nullableOptional

SurveyFormStatusstring · nullableOptional

UserFeedbackstring · nullableOptional

AssetNumberinteger · int32Optional

BranchCountinteger · int32Optional

ConditionCountinteger · int32Optional

PageCountinteger · int32Optional

QuestionCountinteger · int32Optional

ResponseLimitPerUserinteger · int32 · nullableOptional

SurveyFormDurationMinutesinteger · int32 · nullableOptional

LastChangeTimestring · date-timeOptional

SurveyFormClosedstring · date-time · nullableOptional

SurveyFormLockedstring · date-time · nullableOptional

SurveyFormOpenedstring · date-time · nullableOptional

404

Not Found

application/jsontext/json

get/api/workflows/forms/{form}

HTTPcURLJavaScriptPython

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

{
  "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "SurveyFormId": "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-08-09T21:37:54.016Z",
  "SurveyFormClosed": "2026-08-09T21:37:54.016Z",
  "SurveyFormLocked": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpened": "2026-08-09T21:37:54.016Z"
}

Checks for the existence of one specific form

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

head/api/workflows/forms/{form}

HTTPcURLJavaScriptPython

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

No content

Collects the list of forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

SurveyFormClosedSincestring · date-time · nullableOptional

SurveyFormClosedBeforestring · date-time · nullableOptional

SurveyFormLockedSincestring · date-time · nullableOptional

SurveyFormLockedBeforestring · date-time · nullableOptional

SurveyFormOpenedSincestring · date-time · nullableOptional

SurveyFormOpenedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

LastChangeUserstring · uuidOptional

SurveyFormIdstring · uuidOptional

SurveyMessageInvitationstring · uuid · nullableOptional

SurveyMessageResponseCompletedstring · uuid · nullableOptional

SurveyMessageResponseConfirmedstring · uuid · nullableOptional

SurveyMessageResponseStartedstring · uuid · nullableOptional

DisplaySummaryChartbooleanOptional

EnableUserConfidentialitybooleanOptional

HasWorkflowConfigurationbooleanOptional

RequireUserAuthenticationbooleanOptional

RequireUserIdentificationbooleanOptional

LastChangeTypestring · nullableOptional

SurveyFormHookstring · nullableOptional

SurveyFormLanguagestring · nullableOptional

SurveyFormLanguageTranslationsstring · nullableOptional

SurveyFormNamestring · nullableOptional

SurveyFormStatusstring · nullableOptional

UserFeedbackstring · nullableOptional

AssetNumberinteger · int32Optional

BranchCountinteger · int32Optional

ConditionCountinteger · int32Optional

PageCountinteger · int32Optional

QuestionCountinteger · int32Optional

ResponseLimitPerUserinteger · int32 · nullableOptional

SurveyFormDurationMinutesinteger · int32 · nullableOptional

LastChangeTimestring · date-timeOptional

SurveyFormClosedstring · date-time · nullableOptional

SurveyFormLockedstring · date-time · nullableOptional

SurveyFormOpenedstring · date-time · nullableOptional

post/api/workflows/forms/collect

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-08-09T21:37:54.016Z",
  "LastChangeTimeBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedBefore": "2026-08-09T21:37:54.016Z"
}

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

200

OK

[
  {
    "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "SurveyFormId": "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-08-09T21:37:54.016Z",
    "SurveyFormClosed": "2026-08-09T21:37:54.016Z",
    "SurveyFormLocked": "2026-08-09T21:37:54.016Z",
    "SurveyFormOpened": "2026-08-09T21:37:54.016Z"
  }
]

Counts the forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

SurveyFormClosedSincestring · date-time · nullableOptional

SurveyFormClosedBeforestring · date-time · nullableOptional

SurveyFormLockedSincestring · date-time · nullableOptional

SurveyFormLockedBeforestring · date-time · nullableOptional

SurveyFormOpenedSincestring · date-time · nullableOptional

SurveyFormOpenedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/workflows/forms/count

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-08-09T21:37:54.016Z",
  "LastChangeTimeBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedBefore": "2026-08-09T21:37:54.016Z"
}

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

SurveyFormClosedSincestring · date-time · nullableOptional

SurveyFormClosedBeforestring · date-time · nullableOptional

SurveyFormLockedSincestring · date-time · nullableOptional

SurveyFormLockedBeforestring · date-time · nullableOptional

SurveyFormOpenedSincestring · date-time · nullableOptional

SurveyFormOpenedBeforestring · date-time · nullableOptional

Responses

200

OK

No content

post/api/workflows/forms/download

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-08-09T21:37:54.016Z",
  "LastChangeTimeBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedBefore": "2026-08-09T21:37:54.016Z"
}

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

SurveyFormClosedSincestring · date-time · nullableOptional

SurveyFormClosedBeforestring · date-time · nullableOptional

SurveyFormLockedSincestring · date-time · nullableOptional

SurveyFormLockedBeforestring · date-time · nullableOptional

SurveyFormOpenedSincestring · date-time · nullableOptional

SurveyFormOpenedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

SurveyFormIdstring · uuidOptional

post/api/workflows/forms/search

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-08-09T21:37:54.016Z",
  "LastChangeTimeBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormClosedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormLockedBefore": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedSince": "2026-08-09T21:37:54.016Z",
  "SurveyFormOpenedBefore": "2026-08-09T21:37:54.016Z"
}

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

200

OK

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