List CRM custom object types

GET/v1/crm/custom-object-types

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

itemsCrmObjectTypeItem[] | nullrequired

Show properties

Array of CrmObjectTypeItem

backing_entitystringrequired

backing_tablestringrequired

domainstringrequired

explicitbooleanrequired

generalizedbooleanrequired

icon_keystringrequired

kindstringrequired

labelstringrequired

plural_labelstringrequired

primary_display_fieldstringrequired

supported_capabilitiesstring[] | nullrequired

supports_custom_fieldsbooleanrequired

supports_listsbooleanrequired

supports_relationshipsbooleanrequired

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/custom-object-types"

const response = await fetch("/v1/crm/custom-object-types", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/crm/custom-object-types",
)

Response

{
  "items": [
    {
      "backing_entity": "string",
      "backing_table": "string",
      "domain": "string",
      "explicit": true,
      "generalized": true,
      "icon_key": "string",
      "kind": "string",
      "label": "string",
      "plural_label": "string",
      "primary_display_field": "string",
      "supported_capabilities": [
        "string"
      ],
      "supports_custom_fields": true,
      "supports_lists": true,
      "supports_relationships": true
    }
  ]
}

{
  "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"
  }
}