SOPs / REFERENCE

Read SOP categories

Read the category hierarchy used to author SOPs.

GET/api/v1/sops/categories

Permissions sops:read

Parameters

Name	Description
`X-Luma-Workspace-Host`header · required	Your workspace host, e.g. acme.lumi-cx.com. Required on api.lumi-cx.com. This header never grants access: the Bearer key must belong to the selected workspace.

Responses

200 Successful operation

{
  "ok": false,
  "categories": {
    "l1": [
      {
        "id": "example",
        "label": "example",
        "order": 1
      }
    ],
    "l2": [
      {
        "id": "example",
        "label": "example",
        "order": 1
      }
    ],
    "l3": [
      {
        "id": "example",
        "label": "example",
        "order": 1
      }
    ],
    "l1l2": [
      {
        "l1Id": "example",
        "l2Id": "example"
      }
    ],
    "l2l3": [
      {
        "l2Id": "example",
        "l3Id": "example"
      }
    ]
  }
}

400 Invalid body or workflow state

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

401 Missing, invalid, expired, revoked or wrong-workspace key

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

403 Required key permission missing, module unavailable, or workspace suspended

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

404 SOP not found or not accessible

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

429 Rate limit exceeded; respect Retry-After

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

502 Upstream or unexpected server error

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}