Pular para o conteúdo principal
POST
/
crm
/
v3
/
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 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 lidas.

Parâmetros de consulta

locale
string

Especifica a localidade do idioma para os valores de propriedade.

Corpo

application/json
archived
boolean
obrigatório

Especifica se a propriedade está arquivada.

dataSensitivity
enum<string>
obrigatório

Indica o nível de confidenciaidade dos dados, como "non_sensitive", "sensitive" ou "highly_sensitive".

Opções disponíveis:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
obrigatório

Resposta

successful operation

completedAt
string<date-time>
obrigatório

A data e a hora que indica quando a operação em lote foi concluída.

results
object[]
obrigatório
startedAt
string<date-time>
obrigatório

A data/hora que indica quando a operação em lote começou a ser processada.

status
enum<string>
obrigatório

O status atual da operação em lote. Os valores possíveis são: CANCELED, COMPLETE, PENDING ou PROCESSING.

Opções disponíveis:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Uma coleção de URLs que direcionam para a documentação ou para recursos relacionados à operação em lote.

numErrors
integer<int32>

O número total de erros encontrados durante a operação em lote.

requestedAt
string<date-time>

A data e a hora que indica quando a operação em lote foi solicitada.

Last modified on March 5, 2026