Pular para o conteúdo principal
POST
/
crm
/
properties
/
2026-03
/
{objectType}
/
batch
/
read
Ler um lote de propriedades
curl --request POST \
  --url https://api.hubapi.com/crm/properties/2026-03/{objectType}/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "archived": true,
  "dataSensitivity": "highly_sensitive",
  "inputs": [
    {
      "name": "<string>"
    }
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "description": "<string>",
      "fieldType": "<string>",
      "groupName": "<string>",
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "hidden": true,
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "displayOrder": 123
        }
      ],
      "type": "<string>",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "calculated": true,
      "calculationFormula": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": "<string>",
      "currencyPropertyName": "<string>",
      "dataSensitivity": "highly_sensitive",
      "dateDisplayHint": "absolute",
      "displayOrder": 123,
      "externalOptions": true,
      "formField": true,
      "hasUniqueValue": true,
      "hidden": false,
      "hubspotDefined": true,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "readOnlyOptions": true
      },
      "numberDisplayHint": "currency",
      "referencedObjectType": "<string>",
      "sensitiveDataCategories": [
        "<string>"
      ],
      "showCurrencySymbol": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedUserId": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Supported products

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

Parâmetros de consulta

locale
string

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

Uma coleção de URLs que direcionam para a documentação ou para recursos relacionados à 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 April 13, 2026