Ctrlk
Shift iQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workflows API: Cases

Retrieves one specific case

get
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
200

OK

AdministratorUserIdstring · uuid · nullableOptional
EmployerGroupIdstring · uuid · nullableOptional
CaseClosedBystring · uuid · nullableOptional
CaseIdstring · uuidOptional
CaseOpenedBystring · uuid · nullableOptional
CaseStatusIdstring · uuid · nullableOptional
LastChangeUserstring · uuidOptional
LawyerUserIdstring · uuid · nullableOptional
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/workflows/cases/{case}
GET /v2/e01/api/workflows/cases/{case} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "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",
  "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-01-01T00:00:00.000Z",
  "CaseOpened": "2026-01-01T00:00:00.000Z",
  "CaseReported": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffective": "2026-01-01T00:00:00.000Z",
  "LastChangeTime": "2026-01-01T00:00:00.000Z"
}

Checks for the existence of one specific case

head
Authorizations
BearerstringRequired
Path parameters
issuestring · uuidRequired
casestringRequired
Responses
200

OK

No content
head/api/workflows/cases/{case}
HEAD /v2/e01/api/workflows/cases/{case} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

AdministratorUserIdstring · uuid · nullableOptional
EmployerGroupIdstring · uuid · nullableOptional
CaseClosedBystring · uuid · nullableOptional
CaseIdstring · uuidOptional
CaseOpenedBystring · uuid · nullableOptional
CaseStatusIdstring · uuid · nullableOptional
LastChangeUserstring · uuidOptional
LawyerUserIdstring · uuid · nullableOptional
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/workflows/cases/collect
POST /v2/e01/api/workflows/cases/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 486

{
  "CaseClosedSince": "2026-01-01T00:00:00.000Z",
  "CaseClosedBefore": "2026-01-01T00:00:00.000Z",
  "CaseOpenedSince": "2026-01-01T00:00:00.000Z",
  "CaseOpenedBefore": "2026-01-01T00:00:00.000Z",
  "CaseReportedSince": "2026-01-01T00:00:00.000Z",
  "CaseReportedBefore": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveSince": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
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",
    "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-01-01T00:00:00.000Z",
    "CaseOpened": "2026-01-01T00:00:00.000Z",
    "CaseReported": "2026-01-01T00:00:00.000Z",
    "CaseStatusEffective": "2026-01-01T00:00:00.000Z",
    "LastChangeTime": "2026-01-01T00:00:00.000Z"
  }
]

Counts the cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/workflows/cases/count
POST /v2/e01/api/workflows/cases/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 486

{
  "CaseClosedSince": "2026-01-01T00:00:00.000Z",
  "CaseClosedBefore": "2026-01-01T00:00:00.000Z",
  "CaseOpenedSince": "2026-01-01T00:00:00.000Z",
  "CaseOpenedBefore": "2026-01-01T00:00:00.000Z",
  "CaseReportedSince": "2026-01-01T00:00:00.000Z",
  "CaseReportedBefore": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveSince": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

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

Downloads the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

No content
post/api/workflows/cases/download
POST /v2/e01/api/workflows/cases/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 486

{
  "CaseClosedSince": "2026-01-01T00:00:00.000Z",
  "CaseClosedBefore": "2026-01-01T00:00:00.000Z",
  "CaseOpenedSince": "2026-01-01T00:00:00.000Z",
  "CaseOpenedBefore": "2026-01-01T00:00:00.000Z",
  "CaseReportedSince": "2026-01-01T00:00:00.000Z",
  "CaseReportedBefore": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveSince": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

No content

Searches for the list of cases that match specific criteria

post
Authorizations
BearerstringRequired
Body
CaseClosedSincestring · date-time · nullableOptional
CaseClosedBeforestring · date-time · nullableOptional
CaseOpenedSincestring · date-time · nullableOptional
CaseOpenedBeforestring · date-time · nullableOptional
CaseReportedSincestring · date-time · nullableOptional
CaseReportedBeforestring · date-time · nullableOptional
CaseStatusEffectiveSincestring · date-time · nullableOptional
CaseStatusEffectiveBeforestring · date-time · nullableOptional
LastChangeTimeSincestring · date-time · nullableOptional
LastChangeTimeBeforestring · date-time · nullableOptional
Responses
200

OK

CaseIdstring · uuidOptional
post/api/workflows/cases/search
POST /v2/e01/api/workflows/cases/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 486

{
  "CaseClosedSince": "2026-01-01T00:00:00.000Z",
  "CaseClosedBefore": "2026-01-01T00:00:00.000Z",
  "CaseOpenedSince": "2026-01-01T00:00:00.000Z",
  "CaseOpenedBefore": "2026-01-01T00:00:00.000Z",
  "CaseReportedSince": "2026-01-01T00:00:00.000Z",
  "CaseReportedBefore": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveSince": "2026-01-01T00:00:00.000Z",
  "CaseStatusEffectiveBefore": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeSince": "2026-01-01T00:00:00.000Z",
  "LastChangeTimeBefore": "2026-01-01T00:00:00.000Z"
}
200

OK

[
  {
    "CaseId": "123e4567-e89b-12d3-a456-426614174000"
  }
]
get
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
200

OK

CaseTypestring · nullableOptional
StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
get/api/workflows/cases-statuses/{statusId}
GET /v2/e01/api/workflows/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "CaseType": "text",
  "StatusId": "123e4567-e89b-12d3-a456-426614174000",
  "StatusName": "text",
  "StatusSequence": 1,
  "StatusCategory": "text",
  "ReportCategory": "text",
  "StatusDescription": "text"
}
put
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Body
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
Responses
200

OK

CaseTypestring · nullableOptional
StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
put/api/workflows/cases-statuses/{statusId}
PUT /v2/e01/api/workflows/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"
}
{
  "CaseType": "text",
  "StatusId": "123e4567-e89b-12d3-a456-426614174000",
  "StatusName": "text",
  "StatusSequence": 1,
  "StatusCategory": "text",
  "ReportCategory": "text",
  "StatusDescription": "text"
}
delete
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
204

No Content

No content
delete/api/workflows/cases-statuses/{statusId}
DELETE /v2/e01/api/workflows/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content
head
Authorizations
BearerstringRequired
Path parameters
statusIdstring · uuidRequired
Responses
200

OK

No content
head/api/workflows/cases-statuses/{statusId}
HEAD /v2/e01/api/workflows/cases-statuses/{statusId} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content
get
Authorizations
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

Countinteger · int32Optional
Summarystring · nullableOptional
get/api/workflows/cases-statuses/count
GET /v2/e01/api/workflows/cases-statuses/count HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*
200

OK

{
  "Count": 1,
  "Summary": "text"
}
post
Authorizations
BearerstringRequired
Body
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

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/workflows/cases-statuses/count
POST /v2/e01/api/workflows/cases-statuses/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 274

{
  "CaseTypeContains": "text",
  "CaseTypeExact": "text",
  "StatusNameContains": "text",
  "StatusNameExact": "text",
  "StatusCategoryContains": "text",
  "StatusCategoryExact": "text",
  "ReportCategoryContains": "text",
  "ReportCategoryExact": "text",
  "StatusSequenceSince": 1,
  "StatusSequenceBefore": 1
}
200

OK

{
  "Count": 1,
  "Summary": "text"
}
get
Authorizations
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

CaseTypestring · nullableOptional
StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
get/api/workflows/cases-statuses
GET /v2/e01/api/workflows/cases-statuses HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "CaseType": "text",
    "StatusId": "123e4567-e89b-12d3-a456-426614174000",
    "StatusName": "text",
    "StatusSequence": 1,
    "StatusCategory": "text",
    "ReportCategory": "text",
    "StatusDescription": "text"
  }
]
post
Authorizations
BearerstringRequired
Body
CaseTypestring · nullableOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
Responses
201

Created

CaseTypestring · nullableOptional
StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
post/api/workflows/cases-statuses
POST /v2/e01/api/workflows/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"
}
{
  "CaseType": "text",
  "StatusId": "123e4567-e89b-12d3-a456-426614174000",
  "StatusName": "text",
  "StatusSequence": 1,
  "StatusCategory": "text",
  "ReportCategory": "text",
  "StatusDescription": "text"
}
post
Authorizations
BearerstringRequired
Body
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

CaseTypestring · nullableOptional
StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
StatusSequenceinteger · int32Optional
StatusCategorystring · nullableOptional
ReportCategorystring · nullableOptional
StatusDescriptionstring · nullableOptional
post/api/workflows/cases-statuses/collect
POST /v2/e01/api/workflows/cases-statuses/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 274

{
  "CaseTypeContains": "text",
  "CaseTypeExact": "text",
  "StatusNameContains": "text",
  "StatusNameExact": "text",
  "StatusCategoryContains": "text",
  "StatusCategoryExact": "text",
  "ReportCategoryContains": "text",
  "ReportCategoryExact": "text",
  "StatusSequenceSince": 1,
  "StatusSequenceBefore": 1
}
200

OK

[
  {
    "CaseType": "text",
    "StatusId": "123e4567-e89b-12d3-a456-426614174000",
    "StatusName": "text",
    "StatusSequence": 1,
    "StatusCategory": "text",
    "ReportCategory": "text",
    "StatusDescription": "text"
  }
]
Authorizations
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

StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
CaseTypestring · nullableOptional
StatusCategorystring · nullableOptional
StatusSequenceinteger · int32Optional
get/api/workflows/cases-statuses/search
GET /v2/e01/api/workflows/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
BearerstringRequired
Body
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

StatusIdstring · uuidOptional
StatusNamestring · nullableOptional
CaseTypestring · nullableOptional
StatusCategorystring · nullableOptional
StatusSequenceinteger · int32Optional
post/api/workflows/cases-statuses/search
POST /v2/e01/api/workflows/cases-statuses/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 274

{
  "CaseTypeContains": "text",
  "CaseTypeExact": "text",
  "StatusNameContains": "text",
  "StatusNameExact": "text",
  "StatusCategoryContains": "text",
  "StatusCategoryExact": "text",
  "ReportCategoryContains": "text",
  "ReportCategoryExact": "text",
  "StatusSequenceSince": 1,
  "StatusSequenceBefore": 1
}
200

OK

[
  {
    "StatusId": "123e4567-e89b-12d3-a456-426614174000",
    "StatusName": "text",
    "CaseType": "text",
    "StatusCategory": "text",
    "StatusSequence": 1
  }
]
get
Authorizations
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/workflows/cases-statuses/download
GET /v2/e01/api/workflows/cases-statuses/download HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*
200

OK

No content
post
Authorizations
BearerstringRequired
Body
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/workflows/cases-statuses/download
POST /v2/e01/api/workflows/cases-statuses/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 274

{
  "CaseTypeContains": "text",
  "CaseTypeExact": "text",
  "StatusNameContains": "text",
  "StatusNameExact": "text",
  "StatusCategoryContains": "text",
  "StatusCategoryExact": "text",
  "ReportCategoryContains": "text",
  "ReportCategoryExact": "text",
  "StatusSequenceSince": 1,
  "StatusSequenceBefore": 1
}
200

OK

No content
PreviousVariants API: CMDS
NextWorkflows API: Forms

Last updated

Was this helpful?