Surveys / REFERENCE

List surveys

Return paginated active survey metadata, including drafts. Archived surveys are omitted.

GET/api/v1/surveys

Permissions surveys: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.
`limit`query	Maximum records to return.
`offset`query	Number of records to skip.

Responses

200 Successful operation

{
  "ok": true,
  "surveys": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "name": "example",
      "nameAr": "example",
      "team": "example",
      "createdBy": "example",
      "status": "draft",
      "themeLogoUrl": "example",
      "themePrimaryColor": "example",
      "targetingRules": {},
      "designId": "00000000-0000-4000-8000-000000000001",
      "currentVersionId": "00000000-0000-4000-8000-000000000001",
      "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"
}