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
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
curl --request GET \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>'{
"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"
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Ler todas as propriedades
Leia todas as propriedades existentes para o tipo de objeto e a conta da HubSpot especificados.
curl --request GET \
--url https://api.hubapi.com/crm/v3/properties/{objectType} \
--header 'Authorization: Bearer <token>'{
"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"
}
],
"paging": {
"next": {
"after": "<string>",
"link": "<string>"
},
"prev": {
"before": "<string>",
"link": "<string>"
}
}
}Produtos suportados
Produtos suportados
Marketing Hub -Grátis
Sales Hub -Grátis
Service Hub -Grátis
Content Hub -GrátisEscopos Necessários
Escopos Necessários
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Se apenas os resultados que foram arquivados devem ser retornados.
highly_sensitive, non_sensitive, sensitive Response
successful operation
Mostrar atributos filhos
Mostrar atributos filhos
Uma descrição da propriedade que será exibida como texto de ajuda no HubSpot.
Controla como a propriedade aparece no HubSpot.
O nome do grupo de propriedades ao qual a propriedade pertence.
Um rótulo de propriedade legível por humanos que será exibido no HubSpot.
O nome interno da propriedade, que deve ser usado ao referenciá-la via API.
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
Mostrar atributos filhos
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.
Um rótulo de opção legível por humanos que será exibido no HubSpot.
O valor interno da opção, que deve ser usado ao definir o valor da propriedade através da API.
Uma descrição da opção.
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.
O tipo de dados da propriedade.
Se a propriedade está arquivada ou não.
Quando a propriedade foi arquivada.
Para propriedades padrão, verdadeiro indica que a propriedade é calculada por um processo da HubSpot. Não tem efeito para propriedades personalizadas.
Representa uma fórmula que é usada para calcular uma propriedade de cálculo.
A data e hora em que a propriedade foi criada, no formato ISO 8601.
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.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
highly_sensitive, non_sensitive, sensitive absolute, absolute_with_relative, time_since, time_until As propriedades são mostradas em ordem, começando com o menor valor inteiro positivo.
Para propriedades padrão, verdadeiro indica que as opções são armazenadas externamente às configurações da propriedade.
Se a propriedade pode ser usada em um formulário da HubSpot.
Se o valor da propriedade deve ser exclusivo ou não. Uma vez definido, isso não pode ser alterado.
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.
Será verdadeiro para propriedades de objeto padrão incorporadas ao HubSpot.
Se esta propriedade estiver relacionada a outro(s) objeto(s), ele(s) será(ão) listado(s) aqui.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Se a propriedade exibirá ou não o símbolo da moeda definido nas configurações da conta.
A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.
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.
Mostrar atributos filhos
Mostrar atributos filhos
specifies the paging information needed to retrieve the previous set of results in a paginated API response