List a workspace’s lists

Returns every list across all object types in the workspace as a paginated JSON:API collection. Filter by object type with filter[entity]. Dynamic lists are excluded unless you pass a matching filter.

Authorization

Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Query Parameters

page?

Offset pagination, e.g. page[offset]=0&page[limit]=100.

Default

{  "offset": 0,  "limit": 500}

sortOrder?

Sort order, e.g. sortOrder[column]=_created_at&sortOrder[dir]=DESC.

filter?

Nested filter object, e.g. filter[entity]=deal&filter[type]=static. When omitted, dynamic lists are excluded.

search?string

Case-insensitive substring match against the list title.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/workspaces/string/lists"

{  "links": {    "next": null,    "prev": null  },  "meta": {    "total_records": 1,    "total_pages": 1,    "offset": 0,    "limit": 500  },  "data": [    {      "type": "list",      "id": "9d2c4e6f-8a1b-4c3d-9e5f-7a9b1c3d5e7f",      "attributes": {        "_id": "9d2c4e6f-8a1b-4c3d-9e5f-7a9b1c3d5e7f",        "user_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",        "entity": "deal",        "title": "Enterprise deals",        "emoji": "🏢",        "description": "Open deals with enterprise accounts.",        "type": "dynamic",        "state": "published",        "layout": "table",        "options": {},        "query": {          "sql": "SELECT * FROM deal WHERE amount >= 50000"        },        "owner_id": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",        "rank": 0,        "applied_version_id": null,        "list_evaluation_status": "idle",        "list_evaluation_started_at": null,        "last_list_evaluation_at": "2026-02-01T17:45:00.000Z",        "_updated_at": "2026-02-01T17:45:00.000Z",        "_updated_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81",        "_created_at": "2026-01-15T09:30:00.000Z",        "_created_by": "7d4e2f9a-1b3c-4d5e-8f6a-9c0b2d4e6f81"      }    }  ]}