Workflows API: Forms

Retrieves one specific form

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/workflows/forms/{form}

HTTPcURLJavaScriptPython

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

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific form

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

surveyFormstring · uuidRequired

formstringRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

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

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-05-07T18:22:08.871Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedBefore": "2026-05-07T18:22:08.871Z"
}

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-05-07T18:22:08.871Z",
    "SurveyFormClosed": "2026-05-07T18:22:08.871Z",
    "SurveyFormLocked": "2026-05-07T18:22:08.871Z",
    "SurveyFormOpened": "2026-05-07T18:22:08.871Z"
  }
]

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

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-05-07T18:22:08.871Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedBefore": "2026-05-07T18:22:08.871Z"
}

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

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-05-07T18:22:08.871Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedBefore": "2026-05-07T18:22:08.871Z"
}

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

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-05-07T18:22:08.871Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormClosedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormLockedBefore": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedSince": "2026-05-07T18:22:08.871Z",
  "SurveyFormOpenedBefore": "2026-05-07T18:22:08.871Z"
}

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

200

OK

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