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

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.

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 o tipo de objeto deste esquema. Será definido como {meta-type}-{unique ID}.

​
labels
object
obrigatório

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

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

Um nome exclusivo para o tipo de objeto do esquema.

​
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.

​
archived
boolean
​
createdAt
string<date-time>

Quando o esquema do 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 esquema do objeto foi atualizado pela última vez.

​
updatedByUserId
integer<int32>
Last modified on December 8, 2025