Workflows API: Submissions

Retrieves one specific submission

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/workflows/submissions/{submission}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflows/submissions/{submission} 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 submission

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

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/submissions/{submission}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflows/submissions/{submission} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

ResponseSessionCompletedSincestring · date-time · nullableOptional

ResponseSessionCompletedBeforestring · date-time · nullableOptional

ResponseSessionCreatedSincestring · date-time · nullableOptional

ResponseSessionCreatedBeforestring · date-time · nullableOptional

ResponseSessionStartedSincestring · date-time · nullableOptional

ResponseSessionStartedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflows/submissions/collect

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-05-07T18:22:33.404Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedBefore": "2026-05-07T18:22:33.404Z"
}

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

200

OK

[
  {
    "GroupId": "123e4567-e89b-12d3-a456-426614174000",
    "LastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
    "LastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "PeriodId": "123e4567-e89b-12d3-a456-426614174000",
    "RespondentUserId": "123e4567-e89b-12d3-a456-426614174000",
    "ResponseSessionId": "123e4567-e89b-12d3-a456-426614174000",
    "SurveyFormId": "123e4567-e89b-12d3-a456-426614174000",
    "ResponseIsLocked": true,
    "LastChangeType": "text",
    "RespondentLanguage": "text",
    "ResponseSessionStatus": "text",
    "LastChangeTime": "2026-05-07T18:22:33.404Z",
    "ResponseSessionCompleted": "2026-05-07T18:22:33.404Z",
    "ResponseSessionCreated": "2026-05-07T18:22:33.404Z",
    "ResponseSessionStarted": "2026-05-07T18:22:33.404Z"
  }
]

Counts the submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

ResponseSessionCompletedSincestring · date-time · nullableOptional

ResponseSessionCompletedBeforestring · date-time · nullableOptional

ResponseSessionCreatedSincestring · date-time · nullableOptional

ResponseSessionCreatedBeforestring · date-time · nullableOptional

ResponseSessionStartedSincestring · date-time · nullableOptional

ResponseSessionStartedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflows/submissions/count

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-05-07T18:22:33.404Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedBefore": "2026-05-07T18:22:33.404Z"
}

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

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

ResponseSessionCompletedSincestring · date-time · nullableOptional

ResponseSessionCompletedBeforestring · date-time · nullableOptional

ResponseSessionCreatedSincestring · date-time · nullableOptional

ResponseSessionCreatedBeforestring · date-time · nullableOptional

ResponseSessionStartedSincestring · date-time · nullableOptional

ResponseSessionStartedBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/workflows/submissions/download

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-05-07T18:22:33.404Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedBefore": "2026-05-07T18:22:33.404Z"
}

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

200

OK

No content

Searches for the list of submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

ResponseSessionCompletedSincestring · date-time · nullableOptional

ResponseSessionCompletedBeforestring · date-time · nullableOptional

ResponseSessionCreatedSincestring · date-time · nullableOptional

ResponseSessionCreatedBeforestring · date-time · nullableOptional

ResponseSessionStartedSincestring · date-time · nullableOptional

ResponseSessionStartedBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workflows/submissions/search

HTTPcURLJavaScriptPython

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

{
  "LastChangeTimeSince": "2026-05-07T18:22:33.404Z",
  "LastChangeTimeBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCompletedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionCreatedBefore": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedSince": "2026-05-07T18:22:33.404Z",
  "ResponseSessionStartedBefore": "2026-05-07T18:22:33.404Z"
}

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

200

OK

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