Skip to main content
GET
/
api
/
document-statuses
/
{id}
Get DocumentStatus by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/document-statuses/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "color": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "icon": "<string>",
  "id": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "statusType": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The DocumentStatus

A document status defines a named state for tracking document processing progress.

​
changeSequence
integer<int32>
​
color
string
​
createdOn
string<date-time>
​
icon
string
​
id
string
​
slug
string
​
status
string
​
statusType
string
​
updatedOn
string<date-time>
​
uuid
string