Workflow 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

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

get

/api/workflow/submissions/{submission}

HTTPcURLJavaScriptPython

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

200

OK

{
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "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-03-13T15:18:11.100Z",
  "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
  "responseSessionCreated": "2026-03-13T15:18:11.100Z",
  "responseSessionStarted": "2026-03-13T15:18:11.100Z"
}

Checks for the existence of one specific submission

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/submissions/{submission}

HTTPcURLJavaScriptPython

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

200

OK

true

Collects the list of submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

lastAnsweredQuestionIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdstring · uuid · nullableOptional

respondentUserIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

responseIsLockedboolean · nullableOptional

lastChangeTypestring · nullableOptional

respondentLanguagestring · nullableOptional

responseSessionStatusstring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

responseSessionCompletedstring · date-time · nullableOptional

responseSessionCreatedstring · date-time · nullableOptional

responseSessionStartedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

groupIdstring · uuid · nullableOptional

lastAnsweredQuestionIdstring · uuid · nullableOptional

lastChangeUserstring · uuidOptional

organizationIdstring · 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/workflow/submissions/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:11.100Z",
    "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"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-03-13T15:18:11.100Z",
  "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
  "responseSessionCreated": "2026-03-13T15:18:11.100Z",
  "responseSessionStarted": "2026-03-13T15:18:11.100Z"
}

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",
    "organizationId": "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-03-13T15:18:11.100Z",
    "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
    "responseSessionCreated": "2026-03-13T15:18:11.100Z",
    "responseSessionStarted": "2026-03-13T15:18:11.100Z"
  }
]

Counts the submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

lastAnsweredQuestionIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdstring · uuid · nullableOptional

respondentUserIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

responseIsLockedboolean · nullableOptional

lastChangeTypestring · nullableOptional

respondentLanguagestring · nullableOptional

responseSessionStatusstring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

responseSessionCompletedstring · date-time · nullableOptional

responseSessionCreatedstring · date-time · nullableOptional

responseSessionStartedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/submissions/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:11.100Z",
    "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"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-03-13T15:18:11.100Z",
  "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
  "responseSessionCreated": "2026-03-13T15:18:11.100Z",
  "responseSessionStarted": "2026-03-13T15:18:11.100Z"
}

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

lastAnsweredQuestionIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdstring · uuid · nullableOptional

respondentUserIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

responseIsLockedboolean · nullableOptional

lastChangeTypestring · nullableOptional

respondentLanguagestring · nullableOptional

responseSessionStatusstring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

responseSessionCompletedstring · date-time · nullableOptional

responseSessionCreatedstring · date-time · nullableOptional

responseSessionStartedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/workflow/submissions/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:11.100Z",
    "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"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-03-13T15:18:11.100Z",
  "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
  "responseSessionCreated": "2026-03-13T15:18:11.100Z",
  "responseSessionStarted": "2026-03-13T15:18:11.100Z"
}

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

lastAnsweredQuestionIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdstring · uuid · nullableOptional

respondentUserIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

responseIsLockedboolean · nullableOptional

lastChangeTypestring · nullableOptional

respondentLanguagestring · nullableOptional

responseSessionStatusstring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

responseSessionCompletedstring · date-time · nullableOptional

responseSessionCreatedstring · date-time · nullableOptional

responseSessionStartedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

responseSessionIdstring · uuidOptional

post

/api/workflow/submissions/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:11.100Z",
    "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"
  },
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodId": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-03-13T15:18:11.100Z",
  "responseSessionCompleted": "2026-03-13T15:18:11.100Z",
  "responseSessionCreated": "2026-03-13T15:18:11.100Z",
  "responseSessionStarted": "2026-03-13T15:18:11.100Z"
}

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

200

OK

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