Workflows API: Submissions

Retrieves one specific submission

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

200

OK

application/jsontext/json

GroupIdstring · uuid · nullableOptional

LastAnsweredQuestionIdstring · uuid · nullableOptional

LastChangeUserstring · uuidOptional

PeriodIdstring · uuid · nullableOptional

RespondentUserIdstring · uuidOptional

ResponseSessionIdstring · uuidOptional

SurveyFormIdstring · uuidOptional

ResponseIsLockedbooleanOptional

LastChangeTypestring · nullableOptional

RespondentLanguagestring · nullableOptional

ResponseSessionStatusstring · nullableOptional

LastChangeTimestring · date-timeOptional

ResponseSessionCompletedstring · date-time · nullableOptional

ResponseSessionCreatedstring · date-time · nullableOptional

ResponseSessionStartedstring · date-time · nullableOptional

404

Not Found

application/jsontext/json

get/api/workflows/submissions/{submission}

HTTPcURLJavaScriptPython

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

{
  "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-08-09T21:24:43.356Z",
  "ResponseSessionCompleted": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreated": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStarted": "2026-08-09T21:24:43.356Z"
}

Checks for the existence of one specific submission

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

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

GroupIdstring · uuid · nullableOptional

LastAnsweredQuestionIdstring · uuid · nullableOptional

LastChangeUserstring · uuidOptional

PeriodIdstring · uuid · nullableOptional

RespondentUserIdstring · uuidOptional

ResponseSessionIdstring · uuidOptional

SurveyFormIdstring · uuidOptional

ResponseIsLockedbooleanOptional

LastChangeTypestring · nullableOptional

RespondentLanguagestring · nullableOptional

ResponseSessionStatusstring · nullableOptional

LastChangeTimestring · date-timeOptional

ResponseSessionCompletedstring · date-time · nullableOptional

ResponseSessionCreatedstring · date-time · nullableOptional

ResponseSessionStartedstring · date-time · nullableOptional

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-08-09T21:24:43.356Z",
  "LastChangeTimeBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedBefore": "2026-08-09T21:24:43.356Z"
}

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-08-09T21:24:43.356Z",
    "ResponseSessionCompleted": "2026-08-09T21:24:43.356Z",
    "ResponseSessionCreated": "2026-08-09T21:24:43.356Z",
    "ResponseSessionStarted": "2026-08-09T21:24:43.356Z"
  }
]

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

Countinteger · int32Optional

Summarystring · nullableOptional

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-08-09T21:24:43.356Z",
  "LastChangeTimeBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedBefore": "2026-08-09T21:24:43.356Z"
}

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

No content

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-08-09T21:24:43.356Z",
  "LastChangeTimeBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedBefore": "2026-08-09T21:24:43.356Z"
}

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

ResponseSessionIdstring · uuidOptional

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-08-09T21:24:43.356Z",
  "LastChangeTimeBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCompletedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionCreatedBefore": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedSince": "2026-08-09T21:24:43.356Z",
  "ResponseSessionStartedBefore": "2026-08-09T21:24:43.356Z"
}

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

200

OK

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