Workflow API: Submissions

Retrieves one specific submission

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

200

OK

application/jsontext/json

get

/api/workflow/submissions/{submission}

HTTPcURLJavaScriptPython

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

200

OK

{
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-01-29T17:50:39.379Z",
  "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
  "responseSessionCreated": "2026-01-29T17:50:39.379Z",
  "responseSessionStarted": "2026-01-29T17:50:39.379Z"
}

Checks for the existence of one specific submission

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

responseSessionstring · uuidRequired

submissionstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

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

groupIdentifierstring · uuid · nullableOptional

lastAnsweredQuestionIdentifierstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdentifierstring · uuid · nullableOptional

respondentUserIdentifierstring · uuid · nullableOptional

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

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: 1176

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:50:39.379Z",
    "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"
  },
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-01-29T17:50:39.379Z",
  "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
  "responseSessionCreated": "2026-01-29T17:50:39.379Z",
  "responseSessionStarted": "2026-01-29T17:50:39.379Z"
}

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

200

OK

[
  {
    "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "responseSessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "responseIsLocked": true,
    "lastChangeType": "text",
    "respondentLanguage": "text",
    "responseSessionStatus": "text",
    "lastChangeTime": "2026-01-29T17:50:39.379Z",
    "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
    "responseSessionCreated": "2026-01-29T17:50:39.379Z",
    "responseSessionStarted": "2026-01-29T17:50:39.379Z"
  }
]

Counts the submissions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdentifierstring · uuid · nullableOptional

lastAnsweredQuestionIdentifierstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdentifierstring · uuid · nullableOptional

respondentUserIdentifierstring · uuid · nullableOptional

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

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: 1176

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:50:39.379Z",
    "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"
  },
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-01-29T17:50:39.379Z",
  "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
  "responseSessionCreated": "2026-01-29T17:50:39.379Z",
  "responseSessionStarted": "2026-01-29T17:50:39.379Z"
}

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

groupIdentifierstring · uuid · nullableOptional

lastAnsweredQuestionIdentifierstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdentifierstring · uuid · nullableOptional

respondentUserIdentifierstring · uuid · nullableOptional

surveyFormIdentifierstring · 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: 1176

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:50:39.379Z",
    "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"
  },
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-01-29T17:50:39.379Z",
  "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
  "responseSessionCreated": "2026-01-29T17:50:39.379Z",
  "responseSessionStarted": "2026-01-29T17:50:39.379Z"
}

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

groupIdentifierstring · uuid · nullableOptional

lastAnsweredQuestionIdentifierstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

periodIdentifierstring · uuid · nullableOptional

respondentUserIdentifierstring · uuid · nullableOptional

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

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: 1176

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:50:39.379Z",
    "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"
  },
  "groupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastAnsweredQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "periodIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "respondentUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "responseIsLocked": true,
  "lastChangeType": "text",
  "respondentLanguage": "text",
  "responseSessionStatus": "text",
  "lastChangeTime": "2026-01-29T17:50:39.379Z",
  "responseSessionCompleted": "2026-01-29T17:50:39.379Z",
  "responseSessionCreated": "2026-01-29T17:50:39.379Z",
  "responseSessionStarted": "2026-01-29T17:50:39.379Z"
}

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

200

OK

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