Passer au contenu principal
POST
/
crm
/
v3
/
properties
/
{objectType}
/
batch
/
read
Lire un lot de propriétés
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"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

objectType
string
requis

Le type d'objet pour lequel les propriétés sont lues.

Paramètres de requête

locale
string

Spécifie la langue locale pour les valeurs de propriété.

Corps

application/json
archived
boolean
requis

Spécifie si la propriété est archivée.

dataSensitivity
enum<string>
requis

Indique le niveau de sensibilité des données, tel que « non_sensible », « sensible » ou « hautement_sensible ».

Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
inputs
object[]
requis

Réponse

successful operation

completedAt
string<date-time>
requis

L'horodatage indiquant le moment où l'opération par lots a été terminée.

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

L'horodatage indiquant le début du traitement de l'opération de lot.

status
enum<string>
requis

Le statut actuel de l'opération par lots, avec les valeurs possibles étant CANCELED, COMPLETE, PENDING ou PROCESSING.

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

Une collection d'URL renvoyant à de la documentation ou des ressources liées à l'opération de lot.

numErrors
integer<int32>

Le nombre total d'erreurs rencontrées pendant l'opération par lot.

requestedAt
string<date-time>

L'horodatage indiquant le moment où l'opération par lots a été demandée.

Last modified on March 5, 2026