Get CRM object record page view

GET/v1/crm/object-types/{objectKind}/records/{objectID}/record-page

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

objectKindstringrequired

objectIDstringrequired

Responses

200OK

configCRMRecordPageConfigrequired

Show properties

configanyrequired

created_atstringrequired

idstringrequired

object_kindstringrequired

updated_atstringrequired

object_kindstringrequired

recordCrmObjectRecordItemrequired

Show properties

created_atstringrequired

custom_fieldsanyrequired

display_namestringrequired

enrichment_summaryobject

fieldsobjectrequired

idstringrequired

kindstringrequired

metadataanyrequired

relationships_summaryobjectrequired

updated_atstringrequired

sectionsobjectrequired

timelineCrmActivityEventItem[] | nullrequired

Show properties

Array of CrmActivityEventItem

actor_idstring | nullrequired

created_atstringrequired

event_typestringrequired

idstringrequired

object_idstringrequired

object_kindstringrequired

payloadanyrequired

timeline_totalinteger<int64>required

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

404Not Found

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/records/string/record-page"

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

import requests

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

Response

{
  "config": {
    "config": "string",
    "created_at": "string",
    "id": "string",
    "object_kind": "string",
    "updated_at": "string"
  },
  "object_kind": "string",
  "record": {
    "created_at": "string",
    "custom_fields": "string",
    "display_name": "string",
    "enrichment_summary": {},
    "fields": {},
    "id": "string",
    "kind": "string",
    "metadata": "string",
    "relationships_summary": {},
    "updated_at": "string"
  },
  "sections": {},
  "timeline": [
    {
      "actor_id": "string",
      "created_at": "string",
      "event_type": "string",
      "id": "string",
      "object_id": "string",
      "object_kind": "string",
      "payload": "string"
    }
  ],
  "timeline_total": 0
}

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

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