List resources in a list

Returns a paginated JSON:API collection of the resources that belong to a specific list, applying the list’s membership on top of any `filter` you pass. Use `include` to embed related resources.

Authorization

apiKey

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.

object*string

The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).

list*string

The unique ID of the list.

Query Parameters

page?

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

sortOrder?

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

include?string

Comma-separated relationship names to embed under relationships and return in included, e.g. include=company,deals.

filter?

Nested filter object keyed by field name, e.g. filter[status]=active or filter[amount][Greater than]=100. See the endpoint description for the full operator syntax.

Response Body

`application/json`

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

{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "total_records": 1,
    "total_pages": 1,
    "offset": 0,
    "limit": 50
  },
  "data": [
    {
      "type": "person",
      "id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
      "attributes": {
        "_id": "5f8b7d2e-9c4a-4e1b-8f3d-2a6c9e0b4d71",
        "name": {
          "first_name": "Jane",
          "last_name": "Doe"
        },
        "email_addresses": {
          "items": [
            "jane@acme.com"
          ]
        },
        "job_title": "VP of Marketing",
        "company_id": "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88",
        "_created_at": "2026-01-15T09:30:00.000Z",
        "_updated_at": "2026-02-01T17:45:00.000Z"
      }
    }
  ],
  "included": []
}