Read a batch of properties

Lesen Sie eine bereitgestellte Liste mit Eigenschaften.

POST /crm/properties/2026-03/{objectType}/batch/read

Einen Batch mit Eigenschaften lesen

cURL

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>"
    }
  ]
}
'

200

{
  "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

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

objectType · string · erforderlich

Abfrageparameter

locale · string

Body

application/json

archived · boolean · erforderlich

Gibt an, ob die Eigenschaft archiviert ist.

dataSensitivity · enum<string> · erforderlich

Gibt die Vertraulichkeitsstufe der Daten an, z. B. „non_sensitive“, „sensitive“ oder „highly_sensitive“.

Verfügbare Optionen: highly_sensitive, non_sensitive, sensitive

inputs · object[] · erforderlich

Show child attributes

Antwort

200

application/json

successful operation

completedAt · string<date-time> · erforderlich

Der Zeitstempel, der angibt, wann der Batch-Vorgang abgeschlossen wurde.

results · object[] · erforderlich

Show child attributes

startedAt · string<date-time> · erforderlich

Der Zeitstempel, der angibt, wann der Batch-Vorgang mit der Verarbeitung begonnen hat.

status · enum<string> · erforderlich

Der aktuelle Status des Batch-Vorgangs mit den möglichen Werten CANCELED, COMPLETE, PENDING oder PROCESSING.

Verfügbare Optionen: CANCELED, COMPLETE, PENDING, PROCESSING

links · object

Eine Sammlung von URLs, die auf Dokumentationen oder Ressourcen verweisen, die sich auf den Batch-Vorgang beziehen.

Show child attributes

requestedAt · string<date-time>

Der Zeitstempel, der angibt, wann der Batch-Vorgang angefragt wurde.