List lists
GET /api/v1/lists: request fields and declared response contract.
GET/api/v1/lists
| Permission | list.read |
|---|---|
| Workspace scope | required |
| Scope target | workspace |
Parameters
Path parameters: none.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| includeArchived | boolean | optional | non-null | false |
| workflowInstanceId | string | optional | nullable | null |
Response
200
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
| data | object | required | non-null | — |
| data.lists | array | required | non-null | — |
| data.showViewAll | boolean | required | non-null | — |
Declared failures
| LIST_QUERY_FAILED | 500 — retryable |
|---|
Readback
This method returns the current state it read.
- lists.list
Request example
Schematic only. Replace placeholders with real values and include all required nested fields.
GET /api/v1/lists HTTP/1.1
Authorization: Bearer <token>
x-merulan-workspace-id: <workspace-id>