Get

[POST] .../v1/documentstatus/get

Returns document status information in the system. List statuses available for a specific document type before displaying or filtering document lifecycle state. The request requires a document_type_id filter; an optional id filter narrows the returned statuses. The response returns translated DocumentStatus records ordered by the stored status order and the current request user must have document status select permission. Missing body, invalid filters, invalid document_type_id, denied access, translation lookup failures, cache/storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
document_type_id int ID of the document type that the status belongs to.
id int Status IDs.

Request Example

{
  "filters": [
    {
      "field": "document_type_id",
      "operator": "Equal",
      "value": "16"
    },
    {
      "field": "id",
      "operator": "In",
      "value": "1,2"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of DocumentStatus Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "document_type_id": 16,
      "name": "Draft",
      "name_var": "APP_DOC_STATUS_DRAFT",
      "order": 1,
      "last_update": 1767225600
    }
  ]
}