SOPs / REFERENCE

Read SOP directory

Read selectable employees and departments synchronized from Company Profile. Use these stable directory IDs in SOP references.

GET/api/v1/sops/directory

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,
  "people": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "example",
      "email": "example",
      "active": false,
      "sourceUserId": "00000000-0000-4000-8000-000000000001"
    }
  ],
  "teams": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "example",
      "active": false,
      "sourceDepartmentId": "00000000-0000-4000-8000-000000000001"
    }
  ]
}

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"
}