Pular para o conteúdo principal
GET
/
crm
/
v3
/
properties
/
{objectType}
Ler todas as propriedades
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"
    }
  ]
}

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 -Grátis

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

O tipo de objeto para o qual as propriedades estão sendo recuperadas.

Parâmetros de consulta

archived
boolean
padrão:false

Se apenas os resultados que foram arquivados devem ser retornados.

dataSensitivity
enum<string>
padrão:non_sensitive

Filtra as propriedades com base no nível de confidencialidade. Os valores aceitos são: highly_sensitive, non_sensitive, sensitive.

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
locale
string

Especifique o local para recuperar as propriedades em um idioma específico.

properties
string

Uma lista de propriedades específicas a serem recuperadas, separadas por vírgulas.

Resposta

successful operation

results
object[]
obrigatório
Last modified on March 5, 2026