Pular para o conteúdo principal
GET
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Recupere o esquema de um objeto personalizado específico.
curl --request GET \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Enterprise
Sales HubSales Hub -Enterprise
Service HubService Hub -Enterprise
Content HubContent Hub -Enterprise

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectType
string
obrigatório

Nome completo ou ID do tipo de objeto do seu esquema.

Parâmetros de consulta

includeAssociationDefinitions
boolean
padrão:true

Inclua as definições das associações relacionadas ao esquema.

includeAuditMetadata
boolean
padrão:true

Inclua metadados sobre o registro de auditoria do esquema.

includePropertyDefinitions
boolean
padrão:true

Inclua as definições das propriedades associadas ao esquema.

Resposta

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
obrigatório

Associações definidas para um determinado tipo de objeto.

id
string
obrigatório

Um ID exclusivo para este tipo de objeto. Será definido como {meta-type}-{unique ID}.

labels
object
obrigatório

Singular and plural labels for the object. Used in CRM display.

Exemplo:
{
"plural": "My objects",
"singular": "My object"
}
name
string
obrigatório

Um nome exclusivo para este objeto. Apenas para uso interno.

properties
object[]
obrigatório

Propriedades definidas para este tipo de objeto.

requiredProperties
string[]
obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

allowsSensitiveProperties
boolean
archived
boolean
createdAt
string<date-time>

Quando o tipo de objeto foi criado.

createdByUserId
integer<int32>
description
string
fullyQualifiedName
string

Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.

objectTypeId
string
primaryDisplayProperty
string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

searchableProperties
string[]

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties
string[]

Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.

updatedAt
string<date-time>

Quando o tipo de objeto foi atualizado pela última vez.

updatedByUserId
integer<int32>
Last modified on March 24, 2026