Clarify API
Record Relationships

List related records

Returns the records linked to a record through the given relationship, e.g. the deals related to a person.

GET
/workspaces/{workspace}/objects/{object}/records/{id}/relationships/{relationship}

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_*).

id*string

The unique ID of the record.

relationship*string

The relationship field name as defined in the object’s schema, e.g. people or companies.

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 list of nested relationship paths to resolve, relative to the parent record, e.g. include=companies.deals.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/objects/string/records/string/relationships/string"
{
  "links": {
    "next": null,
    "prev": null
  },
  "meta": {
    "total_records": 1,
    "total_pages": 1,
    "offset": 0,
    "limit": 500
  },
  "data": [
    {
      "type": "deal",
      "id": "e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42",
      "attributes": {
        "_id": "e7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42",
        "name": "Acme Renewal Q1",
        "stage": "In progress",
        "amount": 50000,
        "close_date": "2026-03-31",
        "company_id": "c0a80121-7ac0-4b1c-8b6d-3e5f9a2d4c88",
        "_created_at": "2026-01-15T09:30:00.000Z",
        "_updated_at": "2026-02-01T17:45:00.000Z"
      }
    }
  ]
}

Unlink related records

Removes the links to the records in `data` from the given relationship. The records themselves are not deleted.

Replace related records

Replaces the full set of records linked through the given relationship with the records in `data`. Links not listed are removed; this is not additive.