Zum Hauptinhalt springen
GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Ler uma propriedade
curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Starter
Esta API requer um dos seguintes escopos:
automation
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.feedback_submissions.read
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Query Parameters

​
archived
boolean
default:false

Se apenas os resultados que foram arquivados devem ser retornados.

​
dataSensitivity
enum<string>
default:non_sensitive
Verfügbare Optionen:
highly_sensitive,
non_sensitive,
sensitive
​
locale
string
​
properties
string

Response

successful operation

A HubSpot property

​
description
string
required

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

​
fieldType
string
required

Controla como a propriedade aparece no HubSpot.

​
groupName
string
required

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

​
label
string
required

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

​
name
string
required

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

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

​
type
string
required

O tipo de dados da propriedade.

​
archived
boolean

Se a propriedade está arquivada ou não.

​
archivedAt
string<date-time>

Quando a propriedade foi arquivada.

​
calculated
boolean

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

​
calculationFormula
string

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

​
createdAt
string<date-time>

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

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

​
dataSensitivity
enum<string>

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

Verfügbare Optionen:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>
Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer

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

​
externalOptions
boolean

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

​
formField
boolean

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

​
hasUniqueValue
boolean

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

​
hidden
boolean

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.

​
hubspotDefined
boolean

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

​
modificationMetadata
object
​
referencedObjectType
string

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

​
sensitiveDataCategories
string[]

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

​
showCurrencySymbol
boolean

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

​
updatedAt
string<date-time>

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

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