L lumi developers

Journeys / REFERENCE

List journeys

Paginated macro and micro journey metadata. Use the detail endpoint to retrieve all versions and full paths.

GET/api/v1/journeys

Permissions journeys:read

Parameters

NameDescription
X-Luma-Workspace-Hostheader · requiredYour 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.
limitqueryMaximum records to return.
offsetqueryNumber of records to skip.

Responses

200 Successful operation
{
  "ok": true,
  "journeys": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "titleEn": "example",
      "titleAr": "example",
      "publishedVersionId": "00000000-0000-4000-8000-000000000001",
      "pairId": "00000000-0000-4000-8000-000000000001",
      "pairVariant": "example",
      "createdAt": "2026-09-26T09:00:00Z",
      "updatedAt": "2026-09-26T09:00:00Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}
400 Invalid request
{
  "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 Record, workspace or route not found
{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}
409 Version changed or the resource is locked
{
  "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"
}
Need an API key? Open Developer Options in your workspace.