Saltar al contenido principal
GET
/
crm-object-schemas
/
2026-03
/
schemas
/
{objectType}
Obtener el esquema de un objeto personalizado específico.
curl --request GET \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "associations": [
    {
      "fromObjectTypeId": "<string>",
      "id": "<string>",
      "toObjectTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "properties": [
    {
      "description": "<string>",
      "fieldType": "<string>",
      "groupName": "<string>",
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "hidden": true,
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "displayOrder": 123
        }
      ],
      "type": "<string>",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "calculated": true,
      "calculationFormula": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": "<string>",
      "currencyPropertyName": "<string>",
      "dataSensitivity": "highly_sensitive",
      "dateDisplayHint": "absolute",
      "displayOrder": 123,
      "externalOptions": true,
      "formField": true,
      "hasUniqueValue": true,
      "hidden": false,
      "hubspotDefined": true,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "readOnlyOptions": true
      },
      "numberDisplayHint": "currency",
      "referencedObjectType": "<string>",
      "sensitiveDataCategories": [
        "<string>"
      ],
      "showCurrencySymbol": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedUserId": "<string>"
    }
  ],
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": 123,
  "description": "<string>",
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": 123
}

Supported products

Autorizaciones

Authorization
string
header
requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Parámetros de ruta

objectType
string
requerido

Nombre completamente calificado o ID del tipo de objeto de tu esquema.

Parámetros de consulta

includeAssociationDefinitions
boolean
predeterminado:true
includeAuditMetadata
boolean
predeterminado:true
includePropertyDefinitions
boolean
predeterminado:true

Respuesta

successful operation

allowsSensitiveProperties
boolean
requerido
archived
boolean
requerido
associations
object[]
requerido

Asociaciones definidas para un tipo de objeto determinado.

fullyQualifiedName
string
requerido

Un ID único asignado para el objeto, que incluye el ID del portal y el nombre del objeto.

id
string
requerido

Un ID único para el tipo de objeto de este esquema. Se definirá como {meta-type}-{unique ID}.

labels
object
requerido
name
string
requerido

Un nombre único para el tipo de objeto del esquema.

objectTypeId
string
requerido
properties
object[]
requerido

Propiedades definidas para este tipo de objeto.

requiredProperties
string[]
requerido

Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.

searchableProperties
string[]
requerido

Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.

secondaryDisplayProperties
string[]
requerido

Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.

createdAt
string<date-time>

Cuando se creó el esquema de objetos.

createdByUserId
integer<int32>
description
string
primaryDisplayProperty
string

El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.

updatedAt
string<date-time>

Cuando se actualizó por última vez el esquema de objetos.

updatedByUserId
integer<int32>
Last modified on April 13, 2026