# List custom object relationship definitions

> `GET` `/v1/custom-object-relationships`

URL: https://www.agencytitan.com/docs/tag/custom-object-relationships/GET/v1/custom-object-relationships

Operation ID: `custom_object_relationships_list`

Tag: [custom_object_relationships](https://www.agencytitan.com/docs/tag/custom-object-relationships.md)

## Description

Returns relationship definitions between custom object types. Each definition identifies the source object, target object, relationship field, and definition-derived cardinality needed to create links.

## Parameters

- `limit` (query, optional, `integer`) — Maximum number of items to return (1-200).
- `offset` (query, optional, `integer`) — Number of items to skip before collecting the result set.
- `order` (query, optional, `string`) — Sort direction. Default `asc`.
- `search` (query, optional, `string`) — Free-text search filter.
- `sort` (query, optional, `string`) — Field to sort by. Default `field_label`.
- `source_object_id` (query, optional, `string`) — Only definitions originating from this custom object. Optional filter. Omit unless the user asked for it; never guess identifiers.
- `target_object_id` (query, optional, `string`) — Only definitions targeting this custom object. Optional filter. Omit unless the user asked for it; never guess identifiers.

## Request body

_None_

## Responses

- `200` (`application/json`): Successful response.
  - Type: `object`
  - Properties:
    - `data` (`array<object>`, required)
    - `pagination` (`object`, required)
- `400` (`application/json`): Request validation failed (unknown or out-of-range parameters/properties are rejected).
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `401` (`application/json`): Missing, invalid, expired, or revoked bearer token.
  - Type: `object`
  - Properties:
    - `error` (`string`, required)
    - `error_description` (`string`, required)
- `403` (`application/json`): The authenticated user does not have permission for this operation.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `404` (`application/json`): The requested resource was not found.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `429` (`application/json`): Per-tenant rate limit exceeded (600 requests/minute across all /v1 REST endpoints). The Retry-After header indicates how many seconds to wait.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)
- `500` (`application/json`): An unexpected internal error occurred.
  - Type: `object`
  - Properties:
    - `error` (`object`, required)

## Authentication

- `bearerAuth` — http (bearer) — All /v1 endpoints (except `/v1/openapi.json` and `/v1/llms.txt`) require a bearer token. Two equal first-class paths: (1) an OAuth 2.0 access token from the au…

## Useful links

- Interactive page: https://www.agencytitan.com/docs/tag/custom-object-relationships/GET/v1/custom-object-relationships
- API reference home: https://www.agencytitan.com/docs/
- Tag page: https://www.agencytitan.com/docs/tag/custom-object-relationships.md
- This operation as Markdown: https://www.agencytitan.com/docs/tag/custom-object-relationships/GET/v1/custom-object-relationships.md
- OpenAPI JSON: https://www.agencytitan.com/docs/openapi.json
- Full API Markdown: https://api.agencytitan.com/v1/llms.txt
- API keys: https://app.agencytitan.com/settings/api-mcp
