List CRM object attributes

GET/v1/crm/object-types/{objectKind}/attributes

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

Responses

200OK

itemsCrmAttributeItem[] | nullrequired

Show properties

Array of CrmAttributeItem

created_atstringrequired

default_valueanyrequired

descriptionstring | nullrequired

display_orderinteger<int32>required

field_typestringrequired

idstringrequired

is_activebooleanrequired

is_multiselectbooleanrequired

is_requiredbooleanrequired

is_uniquebooleanrequired

keystringrequired

labelstringrequired

object_kindstringrequired

optionsanyrequired

relationshipCRMAttributeRelationship

Show properties

cardinalitystringrequired

directionstringrequired

paired_attribute_idstring

paired_attribute_keystringrequired

paired_object_kindstringrequired

related_object_kindstringrequired

relationship_definition_idstringrequired

relationship_keystringrequired

sourcestringrequired

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

422Unprocessable Entity

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

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

import requests

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

Response

{
  "items": [
    {
      "created_at": "string",
      "default_value": "string",
      "description": "string",
      "display_order": 0,
      "field_type": "string",
      "id": "string",
      "is_active": true,
      "is_multiselect": true,
      "is_required": true,
      "is_unique": true,
      "key": "string",
      "label": "string",
      "object_kind": "string",
      "options": "string",
      "relationship": {
        "cardinality": "string",
        "direction": "string",
        "paired_attribute_id": "string",
        "paired_attribute_key": "string",
        "paired_object_kind": "string",
        "related_object_kind": "string",
        "relationship_definition_id": "string",
        "relationship_key": "string"
      },
      "source": "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"
  }
}

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