Relationships

Relationships connect records — people to companies, deals to companies, people to deals. You can also set relationships via foreign key fields (company_id) at creation time.

Get relationships

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

Returns the related records for a given relationship.

{
  "data": [
    {
      "id": "com_01HX9Z2K3M4N5P6Q7R8S9T0A",
      "type": "company"
    },
    {
      "id": "com_01HX9Z2K3M4N5P6Q7R8S9T0B",
      "type": "company"
    }
  ]
}

Set relationship

PATCH /objects/{object}/records/{id}/relationships/{relationship}

Replaces the full set of related records. This is not additive — any existing relationships not in the body are removed.

{
  "data": [
    {
      "id": "com_01HX9Z2K3M4N5P6Q7R8S9T0A",
      "type": "company"
    }
  ]
}

Returns 200 with the updated relationship data on success.

Remove relationship

DELETE /objects/{object}/records/{id}/relationships/{relationship}

Removes specific records from a relationship without affecting others. Uses the same { data: [...] } format.

{
  "data": [
    {
      "id": "com_01HX9Z2K3M4N5P6Q7R8S9T0A",
      "type": "company"
    }
  ]
}

Returns 204 No Content on success.