Ler um lote de propriedades

curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "dataSensitivity": "highly_sensitive",
  "inputs": [
    {
      "name": "my_custom_property"
    }
  ]
}
'

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "displayOrder": 2,
      "fieldType": "select",
      "formField": true,
      "groupName": "contactinformation",
      "hasUniqueValue": false,
      "hidden": false,
      "label": "My Contact Property",
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": false,
        "readOnlyOptions": false,
        "readOnlyValue": false
      },
      "name": "my_contact_property",
      "options": [
        {
          "description": "Choice number one",
          "displayOrder": 1,
          "hidden": false,
          "label": "Option A",
          "value": "A"
        },
        {
          "description": "Choice number two",
          "displayOrder": 2,
          "hidden": false,
          "label": "Option B",
          "value": "B"
        }
      ],
      "type": "enumeration"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

POST

crm

properties

{objectType}

batch

read

Ler um lote de propriedades

curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "dataSensitivity": "highly_sensitive",
  "inputs": [
    {
      "name": "my_custom_property"
    }
  ]
}
'

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "displayOrder": 2,
      "fieldType": "select",
      "formField": true,
      "groupName": "contactinformation",
      "hasUniqueValue": false,
      "hidden": false,
      "label": "My Contact Property",
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": false,
        "readOnlyOptions": false,
        "readOnlyValue": false
      },
      "name": "my_contact_property",
      "options": [
        {
          "description": "Choice number one",
          "displayOrder": 1,
          "hidden": false,
          "label": "Option A",
          "value": "A"
        },
        {
          "description": "Choice number two",
          "displayOrder": 2,
          "hidden": false,
          "label": "Option B",
          "value": "B"
        }
      ],
      "type": "enumeration"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "message": "<string>",
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "subCategory": "<string>"
        }
      ],
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "id": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.

Marketing Hub -Grátis

Sales Hub -Grátis

Service Hub -Grátis

Content Hub -Grátis

Escopos Necessários

Authorizations

Authorization

string

header

required

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

Path Parameters

objectType

string

required

Query Parameters

locale

string

Body

application/json

archived

boolean

required

dataSensitivity

enum<string>

required

Opções disponíveis:

highly_sensitive,

non_sensitive,

sensitive

inputs

object[]

required

Mostrar atributos filhos

inputs.name

string

required

O nome da propriedade a ser lida ou modificada.

Response

successful operation

completedAt

string<date-time>

required

results

object[]

required

Mostrar atributos filhos

results.description

string

required

Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.

results.fieldType

string

required

Controla como a propriedade aparece no HubSpot.

results.groupName

string

required

O nome do grupo de propriedades ao qual a propriedade pertence.

results.label

string

required

Um rótulo de propriedade legível por humanos que será exibido no HubSpot.

results.name

string

required

O nome interno da propriedade, que deve ser usado ao referenciá-la via API.

results.options

object[]

required

Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas, mas estará vazio para outros tipos de propriedade.

Mostrar atributos filhos

results.options.hidden

boolean

required

Se verdadeiro, a opção não será exibida em formulários, bots ou páginas de agendamento de reuniões. Compatível com propriedades de enumeração de contato, empresa, ticket e objeto personalizado.

results.options.label

string

required

Um rótulo de opção legível por humanos que será exibido no HubSpot.

results.options.value

string

required

O valor interno da opção, que deve ser usado ao definir o valor da propriedade através da API.

results.options.description

string

Uma descrição da opção.

results.options.displayOrder

integer<int32>

As opções são exibidas em ordem, começando com o menor valor inteiro positivo. Valores de -1 farão com que a opção seja exibida após os valores positivos.

results.type

string

required

O tipo de dados da propriedade.

results.archived

boolean

Se a propriedade está arquivada ou não.

results.archivedAt

string<date-time>

Quando a propriedade foi arquivada.

results.calculated

boolean

Para propriedades padrão, verdadeiro indica que a propriedade é calculada por um processo da HubSpot. Não tem efeito para propriedades personalizadas.

results.calculationFormula

string

Representa uma fórmula que é usada para calcular uma propriedade de cálculo.

results.createdAt

string<date-time>

A data e hora em que a propriedade foi criada, no formato ISO 8601.

results.createdUserId

string

O ID de usuário interno do usuário que criou a propriedade no HubSpot. Este campo pode não existir se a propriedade foi criada fora do HubSpot.

results.dataSensitivity

enum<string>

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Opções disponíveis:

highly_sensitive,

non_sensitive,

sensitive

results.dateDisplayHint

enum<string>

Opções disponíveis:

absolute,

absolute_with_relative,

time_since,

time_until

results.displayOrder

integer<int32>

As propriedades são mostradas em ordem, começando com o menor valor inteiro positivo.

results.externalOptions

boolean

Para propriedades padrão, verdadeiro indica que as opções são armazenadas externamente às configurações da propriedade.

results.formField

boolean

Se a propriedade pode ser usada em um formulário da HubSpot.

results.hasUniqueValue

boolean

Se o valor da propriedade deve ser exclusivo ou não. Uma vez definido, isso não pode ser alterado.

results.hidden

boolean

results.hubspotDefined

boolean

Será verdadeiro para propriedades de objeto padrão incorporadas ao HubSpot.

results.modificationMetadata

object

Mostrar atributos filhos

results.modificationMetadata.archivable

boolean

required

results.modificationMetadata.readOnlyDefinition

boolean

required

results.modificationMetadata.readOnlyValue

boolean

required

results.modificationMetadata.readOnlyOptions

boolean

results.referencedObjectType

string

Se esta propriedade estiver relacionada a outro(s) objeto(s), ele(s) será(ão) listado(s) aqui.

results.sensitiveDataCategories

string[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

results.showCurrencySymbol

boolean

Se a propriedade exibirá ou não o símbolo da moeda definido nas configurações da conta.

results.updatedAt

string<date-time>

A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.

results.updatedUserId

string

O ID de usuário interno do usuário que atualizou a propriedade no HubSpot. Este campo pode não existir se a propriedade foi atualizada fora do HubSpot.

startedAt

string<date-time>

required

status

enum<string>

required

Opções disponíveis:

CANCELED,

COMPLETE,

PENDING,

PROCESSING

errors

object[]

Mostrar atributos filhos

errors.category

string

required

A categoria principal do erro.

errors.context

object

required

Informações adicionais específicas do contexto relacionadas ao erro.

Mostrar atributos filhos

errors.context.{key}

string[]

errors.errors

object[]

required

Os objetos de erro detalhados.

Mostrar atributos filhos

errors.errors.message

string

required

Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado

errors.errors.code

string

O código de status associado ao detalhe do erro

errors.errors.context

object

Contexto sobre a condição de erro

Mostrar atributos filhos

errors.errors.context.{key}

string[]

Example:

"{missingScopes=[scope1, scope2]}"

errors.errors.in

string

O nome do campo ou parâmetro no qual o erro foi encontrado.

errors.errors.subCategory

string

Uma categoria específica que contém mais detalhes específicos sobre o erro

errors.links

object

required

URLs com links para documentação ou recursos associados ao erro.

Mostrar atributos filhos

errors.links.{key}

string

errors.message

string

required

Uma string legível que descreve o erro e possíveis etapas de correção.

errors.status

string

required

O código de status HTTP associado ao erro.

errors.id

string

Um ID exclusivo para a instância de erro.

errors.subCategory

object

Uma categoria de erro mais específica dentro de cada categoria principal.

links

object

Mostrar atributos filhos

links.{key}

string

numErrors

integer<int32>

requestedAt

string<date-time>

Last modified on December 8, 2025

Arquivar uma propriedade

Criar um lote de propriedades

⌘I

Compromissos

Associações v3

Esquema de associações v3

Associações v4

Esquema de associações v4

Carrinhos

Pagamentos do Commerce

Assinaturas de comércio

Empresas

Contatos

Cursos

[Ativo] Objetos personalizados

Negócios

Descontos

Exportações

Tarifas

Metas

Importações

Faturas

Leads

Itens de linha

Listas

Listas

Objetos

Pedidos

Proprietários

Clientes parceiros

Serviços do parceiro

Pipelines

Produtos

Projetos

Propriedades

Validações de propriedade

Orçamentos

Serviços

Impostos

Tickets

Comunicações

Divisões de negócio

Envios de feedback

Rastreamento de limites

Biblioteca de objetos

Esquemas

Authorizations

Path Parameters

Query Parameters

Body

Response