Saltar al contenido principal
POST
/
crm
/
v3
/
properties
/
{objectType}
/
batch
/
read
Leer un lote de propiedades
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"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

objectType
string
requerido

El tipo de objeto para el que se están leyendo las propiedades.

Parámetros de consulta

locale
string

Especifica la configuración regional del idioma para los valores de la propiedad.

Cuerpo

application/json
archived
boolean
requerido

Especifica si la propiedad está archivada.

dataSensitivity
enum<string>
requerido

Indica el nivel de sensibilidad de los datos, como "non_sensitive", "sensitive" o "highly_sensitive".

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
requerido

Respuesta

successful operation

completedAt
string<date-time>
requerido

La marca de tiempo que indica cuándo se completó la operación por lotes.

results
object[]
requerido
startedAt
string<date-time>
requerido

La marca de tiempo que indica cuándo comenzó a procesarse la operación por lotes.

status
enum<string>
requerido

El estado actual de la operación por lotes, con los siguientes valores posibles: CANCELED, COMPLETE, PENDING o PROCESSING.

Opciones disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Una colección de URL que se enlazan con documentación o recursos relacionados con la operación por lotes.

numErrors
integer<int32>

El número total de errores encontrados durante la operación por lotes.

requestedAt
string<date-time>

La marca de tiempo que indica cuándo se solicitó la operación por lotes.

Last modified on March 19, 2026