Workflow API: Cases

Retrieves one specific case

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

issuestring · uuidRequired

casestringRequired

Responses

200

OK

application/jsontext/json

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseIdstring · uuidOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuidOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32Optional

commentCountinteger · int32Optional

groupCountinteger · int32Optional

caseNumberinteger · int32Optional

personCountinteger · int32Optional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-timeOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-timeOptional

get

/api/workflow/cases/{case}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases/{case} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
  "caseDescription": "text",
  "caseSource": "text",
  "caseStatusCategory": "text",
  "caseTitle": "text",
  "caseType": "text",
  "lastChangeType": "text",
  "attachmentCount": 1,
  "commentCount": 1,
  "groupCount": 1,
  "caseNumber": 1,
  "personCount": 1,
  "caseClosed": "2026-03-13T15:18:12.921Z",
  "caseOpened": "2026-03-13T15:18:12.921Z",
  "caseReported": "2026-03-13T15:18:12.921Z",
  "caseStatusEffective": "2026-03-13T15:18:12.921Z",
  "lastChangeTime": "2026-03-13T15:18:12.921Z"
}

Checks for the existence of one specific case

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

issuestring · uuidRequired

casestringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases/{case}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases/{case} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of cases that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32 · nullableOptional

commentCountinteger · int32 · nullableOptional

groupCountinteger · int32 · nullableOptional

caseNumberinteger · int32 · nullableOptional

personCountinteger · int32 · nullableOptional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-time · nullableOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseIdstring · uuidOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuidOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuidOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32Optional

commentCountinteger · int32Optional

groupCountinteger · int32Optional

caseNumberinteger · int32Optional

personCountinteger · int32Optional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-timeOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-timeOptional

post

/api/workflow/cases/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
  "caseDescription": "text",
  "caseSource": "text",
  "caseStatusCategory": "text",
  "caseTitle": "text",
  "caseType": "text",
  "lastChangeType": "text",
  "attachmentCount": 1,
  "commentCount": 1,
  "groupCount": 1,
  "caseNumber": 1,
  "personCount": 1,
  "caseClosed": "2026-03-13T15:18:12.921Z",
  "caseOpened": "2026-03-13T15:18:12.921Z",
  "caseReported": "2026-03-13T15:18:12.921Z",
  "caseStatusEffective": "2026-03-13T15:18:12.921Z",
  "lastChangeTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

[
  {
    "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
    "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
    "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
    "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
    "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
    "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
    "caseDescription": "text",
    "caseSource": "text",
    "caseStatusCategory": "text",
    "caseTitle": "text",
    "caseType": "text",
    "lastChangeType": "text",
    "attachmentCount": 1,
    "commentCount": 1,
    "groupCount": 1,
    "caseNumber": 1,
    "personCount": 1,
    "caseClosed": "2026-03-13T15:18:12.921Z",
    "caseOpened": "2026-03-13T15:18:12.921Z",
    "caseReported": "2026-03-13T15:18:12.921Z",
    "caseStatusEffective": "2026-03-13T15:18:12.921Z",
    "lastChangeTime": "2026-03-13T15:18:12.921Z"
  }
]

Counts the cases that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32 · nullableOptional

commentCountinteger · int32 · nullableOptional

groupCountinteger · int32 · nullableOptional

caseNumberinteger · int32 · nullableOptional

personCountinteger · int32 · nullableOptional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-time · nullableOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
  "caseDescription": "text",
  "caseSource": "text",
  "caseStatusCategory": "text",
  "caseTitle": "text",
  "caseType": "text",
  "lastChangeType": "text",
  "attachmentCount": 1,
  "commentCount": 1,
  "groupCount": 1,
  "caseNumber": 1,
  "personCount": 1,
  "caseClosed": "2026-03-13T15:18:12.921Z",
  "caseOpened": "2026-03-13T15:18:12.921Z",
  "caseReported": "2026-03-13T15:18:12.921Z",
  "caseStatusEffective": "2026-03-13T15:18:12.921Z",
  "lastChangeTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of cases that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32 · nullableOptional

commentCountinteger · int32 · nullableOptional

groupCountinteger · int32 · nullableOptional

caseNumberinteger · int32 · nullableOptional

personCountinteger · int32 · nullableOptional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-time · nullableOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
  "caseDescription": "text",
  "caseSource": "text",
  "caseStatusCategory": "text",
  "caseTitle": "text",
  "caseType": "text",
  "lastChangeType": "text",
  "attachmentCount": 1,
  "commentCount": 1,
  "groupCount": 1,
  "caseNumber": 1,
  "personCount": 1,
  "caseClosed": "2026-03-13T15:18:12.921Z",
  "caseOpened": "2026-03-13T15:18:12.921Z",
  "caseReported": "2026-03-13T15:18:12.921Z",
  "caseStatusEffective": "2026-03-13T15:18:12.921Z",
  "lastChangeTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

No content

Searches for the list of cases that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

administratorUserIdstring · uuid · nullableOptional

employerGroupIdstring · uuid · nullableOptional

caseClosedBystring · uuid · nullableOptional

caseOpenedBystring · uuid · nullableOptional

caseStatusIdstring · uuid · nullableOptional

lastChangeUserstring · uuid · nullableOptional

lawyerUserIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

ownerUserIdstring · uuid · nullableOptional

responseSessionIdstring · uuid · nullableOptional

topicUserIdstring · uuid · nullableOptional

caseDescriptionstring · nullableOptional

caseSourcestring · nullableOptional

caseStatusCategorystring · nullableOptional

caseTitlestring · nullableOptional

caseTypestring · nullableOptional

lastChangeTypestring · nullableOptional

attachmentCountinteger · int32 · nullableOptional

commentCountinteger · int32 · nullableOptional

groupCountinteger · int32 · nullableOptional

caseNumberinteger · int32 · nullableOptional

personCountinteger · int32 · nullableOptional

caseClosedstring · date-time · nullableOptional

caseOpenedstring · date-time · nullableOptional

caseReportedstring · date-time · nullableOptional

caseStatusEffectivestring · date-time · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

post

/api/workflow/cases/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "administratorUserId": "123e4567-e89b-12d3-a456-426614174000",
  "employerGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseClosedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseOpenedBy": "123e4567-e89b-12d3-a456-426614174000",
  "caseStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeUser": "123e4567-e89b-12d3-a456-426614174000",
  "lawyerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
  "responseSessionId": "123e4567-e89b-12d3-a456-426614174000",
  "topicUserId": "123e4567-e89b-12d3-a456-426614174000",
  "caseDescription": "text",
  "caseSource": "text",
  "caseStatusCategory": "text",
  "caseTitle": "text",
  "caseType": "text",
  "lastChangeType": "text",
  "attachmentCount": 1,
  "commentCount": 1,
  "groupCount": 1,
  "caseNumber": 1,
  "personCount": 1,
  "caseClosed": "2026-03-13T15:18:12.921Z",
  "caseOpened": "2026-03-13T15:18:12.921Z",
  "caseReported": "2026-03-13T15:18:12.921Z",
  "caseStatusEffective": "2026-03-13T15:18:12.921Z",
  "lastChangeTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

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

Retrieves one specific case document

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attachmentstring · uuidRequired

documentstringRequired

Responses

200

OK

application/jsontext/json

attachmentIdstring · uuidOptional

fileIdstring · uuidOptional

caseIdstring · uuidOptional

organizationIdstring · uuid · nullableOptional

posterIdstring · uuidOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-timeOptional

get

/api/workflow/cases-documents/{document}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-documents/{document} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "attachmentId": "123e4567-e89b-12d3-a456-426614174000",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "posterId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "text",
  "fileType": "text",
  "attachmentPosted": "2026-03-13T15:18:12.921Z"
}

Checks for the existence of one specific case document

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

attachmentstring · uuidRequired

documentstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases-documents/{document}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases-documents/{document} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of case documents that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

fileIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

posterIdstring · uuid · nullableOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

attachmentIdstring · uuidOptional

fileIdstring · uuidOptional

caseIdstring · uuidOptional

organizationIdstring · uuid · nullableOptional

posterIdstring · uuidOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-timeOptional

post

/api/workflow/cases-documents/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "posterId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "text",
  "fileType": "text",
  "attachmentPosted": "2026-03-13T15:18:12.921Z"
}

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

200

OK

[
  {
    "attachmentId": "123e4567-e89b-12d3-a456-426614174000",
    "fileId": "123e4567-e89b-12d3-a456-426614174000",
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "posterId": "123e4567-e89b-12d3-a456-426614174000",
    "fileName": "text",
    "fileType": "text",
    "attachmentPosted": "2026-03-13T15:18:12.921Z"
  }
]

Counts the case documents that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

fileIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

posterIdstring · uuid · nullableOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases-documents/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "posterId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "text",
  "fileType": "text",
  "attachmentPosted": "2026-03-13T15:18:12.921Z"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of case documents that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

fileIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

posterIdstring · uuid · nullableOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases-documents/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "posterId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "text",
  "fileType": "text",
  "attachmentPosted": "2026-03-13T15:18:12.921Z"
}

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

200

OK

No content

Searches for the list of case documents that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

fileIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

posterIdstring · uuid · nullableOptional

fileNamestring · nullableOptional

fileTypestring · nullableOptional

attachmentPostedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

attachmentIdstring · uuidOptional

post

/api/workflow/cases-documents/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "fileId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "posterId": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "text",
  "fileType": "text",
  "attachmentPosted": "2026-03-13T15:18:12.921Z"
}

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

200

OK

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

Retrieves one specific case document request

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

issuestring · uuidRequired

requestedFileCategorystringRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

organizationIdstring · uuidOptional

requestedUserIdstring · uuidOptional

requestedFileCategorystring · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-timeOptional

get

/api/workflow/cases-documents-requests/{relationship}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-documents-requests/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedFileCategory": "text",
  "requestedFileDescription": "text",
  "requestedFileSubcategory": "text",
  "requestedFrom": "text",
  "requestedTime": "2026-03-13T15:18:12.921Z"
}

Checks for the existence of one specific case document request

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

issuestring · uuidRequired

requestedFileCategorystringRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases-documents-requests/{relationship}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases-documents-requests/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of case document requests that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

requestedUserIdstring · uuid · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

organizationIdstring · uuidOptional

requestedUserIdstring · uuidOptional

requestedFileCategorystring · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-timeOptional

post

/api/workflow/cases-documents-requests/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/cases-documents-requests/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 687

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedFileDescription": "text",
  "requestedFileSubcategory": "text",
  "requestedFrom": "text",
  "requestedTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

[
  {
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
    "requestedFileCategory": "text",
    "requestedFileDescription": "text",
    "requestedFileSubcategory": "text",
    "requestedFrom": "text",
    "requestedTime": "2026-03-13T15:18:12.921Z"
  }
]

Counts the case document requests that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

requestedUserIdstring · uuid · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases-documents-requests/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/cases-documents-requests/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 687

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedFileDescription": "text",
  "requestedFileSubcategory": "text",
  "requestedFrom": "text",
  "requestedTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of case document requests that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

requestedUserIdstring · uuid · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases-documents-requests/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/cases-documents-requests/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 687

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedFileDescription": "text",
  "requestedFileSubcategory": "text",
  "requestedFrom": "text",
  "requestedTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

No content

Searches for the list of case document requests that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

requestedUserIdstring · uuid · nullableOptional

requestedFileDescriptionstring · nullableOptional

requestedFileSubcategorystring · nullableOptional

requestedFromstring · nullableOptional

requestedTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

requestedFileCategorystring · nullableOptional

post

/api/workflow/cases-documents-requests/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/cases-documents-requests/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 687

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "requestedFileDescription": "text",
  "requestedFileSubcategory": "text",
  "requestedFrom": "text",
  "requestedTime": "2026-03-13T15:18:12.921Z"
}

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

200

OK

[
  {
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "requestedFileCategory": "text"
  }
]

Retrieves one specific case group

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

joinstring · uuidRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

groupIdstring · uuidOptional

caseIdstring · uuidOptional

joinIdstring · uuidOptional

organizationIdstring · uuidOptional

caseRolestring · nullableOptional

get

/api/workflow/cases-groups/{relationship}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-groups/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "joinId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

Checks for the existence of one specific case group

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

joinstring · uuidRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases-groups/{relationship}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases-groups/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of case groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

groupIdstring · uuidOptional

caseIdstring · uuidOptional

joinIdstring · uuidOptional

organizationIdstring · uuidOptional

caseRolestring · nullableOptional

post

/api/workflow/cases-groups/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

[
  {
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "joinId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "caseRole": "text"
  }
]

Counts the case groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases-groups/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of case groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases-groups/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

No content

Searches for the list of case groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

groupIdstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

joinIdstring · uuidOptional

post

/api/workflow/cases-groups/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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",
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

statusIdstring · uuidRequired

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

caseTypestring · nullableOptional

statusIdstring · uuidOptional

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

get

/api/workflow/cases-statuses/{statusId}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseType": "text",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "statusName": "text",
  "statusSequence": 1,
  "statusCategory": "text",
  "reportCategory": "text",
  "statusDescription": "text"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

statusIdstring · uuidRequired

Body

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

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

caseTypestring · nullableOptional

statusIdstring · uuidOptional

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

404

Not Found

application/jsontext/json

put

/api/workflow/cases-statuses/{statusId}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/workflow/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 115

{
  "statusName": "text",
  "statusSequence": 1,
  "statusCategory": "text",
  "reportCategory": "text",
  "statusDescription": "text"
}

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

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseType": "text",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "statusName": "text",
  "statusSequence": 1,
  "statusCategory": "text",
  "reportCategory": "text",
  "statusDescription": "text"
}

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

statusIdstring · uuidRequired

Responses

204

No Content

404

Not Found

application/jsontext/json

delete

/api/workflow/cases-statuses/{statusId}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/workflow/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

statusIdstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases-statuses/{statusId}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

CaseTypeContainsstringOptional

CaseTypeExactstringOptional

StatusNameContainsstringOptional

StatusNameExactstringOptional

StatusCategoryContainsstringOptional

StatusCategoryExactstringOptional

ReportCategoryContainsstringOptional

ReportCategoryExactstringOptional

StatusSequenceSinceinteger · int32Optional

StatusSequenceBeforeinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

get

/api/workflow/cases-statuses/count

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-statuses/count HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "count": 1,
  "summary": "text"
}

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseTypeContainsstring · nullableOptional

caseTypeExactstring · nullableOptional

statusNameContainsstring · nullableOptional

statusNameExactstring · nullableOptional

statusCategoryContainsstring · nullableOptional

statusCategoryExactstring · nullableOptional

reportCategoryContainsstring · nullableOptional

reportCategoryExactstring · nullableOptional

statusSequenceSinceinteger · int32 · nullableOptional

statusSequenceBeforeinteger · int32 · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases-statuses/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseTypeContains": "text",
  "caseTypeExact": "text",
  "statusNameContains": "text",
  "statusNameExact": "text",
  "statusCategoryContains": "text",
  "statusCategoryExact": "text",
  "reportCategoryContains": "text",
  "reportCategoryExact": "text",
  "statusSequenceSince": 1,
  "statusSequenceBefore": 1
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

CaseTypeContainsstringOptional

CaseTypeExactstringOptional

StatusNameContainsstringOptional

StatusNameExactstringOptional

StatusCategoryContainsstringOptional

StatusCategoryExactstringOptional

ReportCategoryContainsstringOptional

ReportCategoryExactstringOptional

StatusSequenceSinceinteger · int32Optional

StatusSequenceBeforeinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

caseTypestring · nullableOptional

statusIdstring · uuidOptional

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

get

/api/workflow/cases-statuses

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-statuses HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "caseType": "text",
    "statusId": "123e4567-e89b-12d3-a456-426614174000",
    "statusName": "text",
    "statusSequence": 1,
    "statusCategory": "text",
    "reportCategory": "text",
    "statusDescription": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

caseTypestring · nullableOptional

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

Responses

201

Created

application/jsontext/json

400

Bad Request

application/jsontext/json

post

/api/workflow/cases-statuses

HTTPcURLJavaScriptPython

POST /v2/e01/api/workflow/cases-statuses HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 133

{
  "caseType": "text",
  "statusName": "text",
  "statusSequence": 1,
  "statusCategory": "text",
  "reportCategory": "text",
  "statusDescription": "text"
}

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

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseType": "text",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "statusName": "text",
  "statusSequence": 1,
  "statusCategory": "text",
  "reportCategory": "text",
  "statusDescription": "text"
}

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseTypeContainsstring · nullableOptional

caseTypeExactstring · nullableOptional

statusNameContainsstring · nullableOptional

statusNameExactstring · nullableOptional

statusCategoryContainsstring · nullableOptional

statusCategoryExactstring · nullableOptional

reportCategoryContainsstring · nullableOptional

reportCategoryExactstring · nullableOptional

statusSequenceSinceinteger · int32 · nullableOptional

statusSequenceBeforeinteger · int32 · nullableOptional

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

caseTypestring · nullableOptional

statusIdstring · uuidOptional

statusNamestring · nullableOptional

statusSequenceinteger · int32Optional

statusCategorystring · nullableOptional

reportCategorystring · nullableOptional

statusDescriptionstring · nullableOptional

post

/api/workflow/cases-statuses/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseTypeContains": "text",
  "caseTypeExact": "text",
  "statusNameContains": "text",
  "statusNameExact": "text",
  "statusCategoryContains": "text",
  "statusCategoryExact": "text",
  "reportCategoryContains": "text",
  "reportCategoryExact": "text",
  "statusSequenceSince": 1,
  "statusSequenceBefore": 1
}

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

200

OK

[
  {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "caseType": "text",
    "statusId": "123e4567-e89b-12d3-a456-426614174000",
    "statusName": "text",
    "statusSequence": 1,
    "statusCategory": "text",
    "reportCategory": "text",
    "statusDescription": "text"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

CaseTypeContainsstringOptional

CaseTypeExactstringOptional

StatusNameContainsstringOptional

StatusNameExactstringOptional

StatusCategoryContainsstringOptional

StatusCategoryExactstringOptional

ReportCategoryContainsstringOptional

ReportCategoryExactstringOptional

StatusSequenceSinceinteger · int32Optional

StatusSequenceBeforeinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/jsontext/json

statusIdstring · uuidOptional

statusNamestring · nullableOptional

caseTypestring · nullableOptional

statusCategorystring · nullableOptional

statusSequenceinteger · int32Optional

get

/api/workflow/cases-statuses/search

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-statuses/search HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "statusId": "123e4567-e89b-12d3-a456-426614174000",
    "statusName": "text",
    "caseType": "text",
    "statusCategory": "text",
    "statusSequence": 1
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseTypeContainsstring · nullableOptional

caseTypeExactstring · nullableOptional

statusNameContainsstring · nullableOptional

statusNameExactstring · nullableOptional

statusCategoryContainsstring · nullableOptional

statusCategoryExactstring · nullableOptional

reportCategoryContainsstring · nullableOptional

reportCategoryExactstring · nullableOptional

statusSequenceSinceinteger · int32 · nullableOptional

statusSequenceBeforeinteger · int32 · nullableOptional

Responses

200

OK

application/jsontext/json

statusIdstring · uuidOptional

statusNamestring · nullableOptional

caseTypestring · nullableOptional

statusCategorystring · nullableOptional

statusSequenceinteger · int32Optional

post

/api/workflow/cases-statuses/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseTypeContains": "text",
  "caseTypeExact": "text",
  "statusNameContains": "text",
  "statusNameExact": "text",
  "statusCategoryContains": "text",
  "statusCategoryExact": "text",
  "reportCategoryContains": "text",
  "reportCategoryExact": "text",
  "statusSequenceSince": 1,
  "statusSequenceBefore": 1
}

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

200

OK

[
  {
    "statusId": "123e4567-e89b-12d3-a456-426614174000",
    "statusName": "text",
    "caseType": "text",
    "statusCategory": "text",
    "statusSequence": 1
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

Query parameters

OrganizationIdstring · uuidOptional

CaseTypeContainsstringOptional

CaseTypeExactstringOptional

StatusNameContainsstringOptional

StatusNameExactstringOptional

StatusCategoryContainsstringOptional

StatusCategoryExactstringOptional

ReportCategoryContainsstringOptional

ReportCategoryExactstringOptional

StatusSequenceSinceinteger · int32Optional

StatusSequenceBeforeinteger · int32Optional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

No content

get

/api/workflow/cases-statuses/download

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-statuses/download HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

caseTypeContainsstring · nullableOptional

caseTypeExactstring · nullableOptional

statusNameContainsstring · nullableOptional

statusNameExactstring · nullableOptional

statusCategoryContainsstring · nullableOptional

statusCategoryExactstring · nullableOptional

reportCategoryContainsstring · nullableOptional

reportCategoryExactstring · nullableOptional

statusSequenceSinceinteger · int32 · nullableOptional

statusSequenceBeforeinteger · int32 · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases-statuses/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "caseTypeContains": "text",
  "caseTypeExact": "text",
  "statusNameContains": "text",
  "statusNameExact": "text",
  "statusCategoryContains": "text",
  "statusCategoryExact": "text",
  "reportCategoryContains": "text",
  "reportCategoryExact": "text",
  "statusSequenceSince": 1,
  "statusSequenceBefore": 1
}

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

200

OK

No content

Retrieves one specific case user

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

joinstring · uuidRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

joinIdstring · uuidOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

caseRolestring · nullableOptional

get

/api/workflow/cases-users/{relationship}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workflow/cases-users/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "joinId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

Checks for the existence of one specific case user

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

joinstring · uuidRequired

relationshipstringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/workflow/cases-users/{relationship}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workflow/cases-users/{relationship} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of case users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

caseIdstring · uuidOptional

joinIdstring · uuidOptional

organizationIdstring · uuidOptional

userIdstring · uuidOptional

caseRolestring · nullableOptional

post

/api/workflow/cases-users/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

[
  {
    "caseId": "123e4567-e89b-12d3-a456-426614174000",
    "joinId": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "caseRole": "text"
  }
]

Counts the case users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/workflow/cases-users/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of case users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

No content

post

/api/workflow/cases-users/download

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

No content

Searches for the list of case users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid · nullableOptional

caseIdstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

caseRolestring · nullableOptional

Responses

200

OK

application/jsontext/json

joinIdstring · uuidOptional

post

/api/workflow/cases-users/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T15:18:12.921Z",
    "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"
  },
  "caseId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "caseRole": "text"
}

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

200

OK

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