Passer au contenu principal
POST
/
crm-object-schemas
/
2026-03
/
schemas
/
batch
/
read
Récupérer plusieurs schémas d'objets personnalisés dans une requête par lots.
curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "includeAssociationDefinitions": true,
  "includeAuditMetadata": true,
  "includePropertyDefinitions": true,
  "inputs": [
    "<string>"
  ]
}
'
{
  "results": [
    {
      "allowsSensitiveProperties": true,
      "archived": true,
      "associations": [
        {
          "fromObjectTypeId": "<string>",
          "id": "<string>",
          "toObjectTypeId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "fullyQualifiedName": "<string>",
      "id": "<string>",
      "labels": {
        "plural": "<string>",
        "singular": "<string>"
      },
      "name": "<string>",
      "objectTypeId": "<string>",
      "properties": [
        {
          "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>",
          "displayOrder": 123,
          "externalOptions": true,
          "formField": true,
          "hasUniqueValue": true,
          "hidden": false,
          "hubspotDefined": true,
          "modificationMetadata": {
            "archivable": true,
            "readOnlyDefinition": true,
            "readOnlyValue": true,
            "readOnlyOptions": true
          },
          "referencedObjectType": "<string>",
          "sensitiveDataCategories": [
            "<string>"
          ],
          "showCurrencySymbol": true,
          "updatedAt": "2023-11-07T05:31:56Z",
          "updatedUserId": "<string>"
        }
      ],
      "requiredProperties": [
        "<string>"
      ],
      "searchableProperties": [
        "<string>"
      ],
      "secondaryDisplayProperties": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "createdByUserId": 123,
      "description": "<string>",
      "primaryDisplayProperty": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedByUserId": 123
    }
  ]
}

Supported products

Autorisations

Authorization
string
header
requis

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

Corps

application/json
includeAssociationDefinitions
boolean
requis

Indique s'il faut inclure les définitions d'association dans la réponse.

includeAuditMetadata
boolean
requis

Indique s'il faut inclure les métadonnées d'audit dans la réponse.

includePropertyDefinitions
boolean
requis

Indique s'il faut inclure les définitions de propriétés dans la réponse.

inputs
string[]
requis

Réponse

successful operation

results
object[]
requis
Dernière modification le 31 mars 2026