List CRM relationship definitions

GET/v1/crm/relationship-definitions

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsCrmRelationshipDefinitionItem[] | nullrequired

Show properties

Array of CrmRelationshipDefinitionItem

cardinalitystringrequired

created_atstringrequired

from_object_kindstringrequired

idstringrequired

inverse_labelstringrequired

is_activebooleanrequired

is_systembooleanrequired

keystringrequired

labelstringrequired

to_object_kindstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/crm/relationship-definitions"

const response = await fetch("/v1/crm/relationship-definitions", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/crm/relationship-definitions",
)

Response

{
  "items": [
    {
      "cardinality": "string",
      "created_at": "string",
      "from_object_kind": "string",
      "id": "string",
      "inverse_label": "string",
      "is_active": true,
      "is_system": true,
      "key": "string",
      "label": "string",
      "to_object_kind": "string",
      "updated_at": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}