Get workflow state

Returns the current workflow state and the transitions available from it.

GET/api/v1/documents/:id/workflow

Authorization

workflow:readapi key scoperequired

Required scope when calling with an API key.

document:workflow_readsession capabilityoptional

Required capability when calling with a signed-in session.

Path parameters

idstringrequired

Document ID

Example: doc_abc123

Request

GET /api/v1/documents/:id/workflow

curl -X GET "https://www.digitalstack360.com/api/v1/documents/doc_abc123/workflow" \
  -H "Authorization: Bearer $DS_API_KEY"

Examples use a placeholder key from your environment. Store your key in $DS_API_KEY — never commit it.

200 OK

{
  "data": {
    "state": "draft",
    "available_transitions": [
      "in_review"
    ],
    "updated_at": "2026-05-12T10:00:00.000Z"
  }
}

Errors

401

missing_auth

No credentials provided

401

invalid_api_key

API key is invalid or revoked

403

scope_insufficient

Key lacks workflow:read scope

404

not_found

Document not found