Pular para o conteúdo principal
POST
/
crm-object-schemas
/
2026-03
/
schemas
/
batch
/
read
Recupere vários esquemas de objetos personalizados em uma solicitação em lote.
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>",
          "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>"
        }
      ],
      "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

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
includeAssociationDefinitions
boolean
obrigatório

Indica se as definições de associação devem ser incluídas na resposta.

includeAuditMetadata
boolean
obrigatório

Indica se os metadados de auditoria devem ser incluídos na resposta.

includePropertyDefinitions
boolean
obrigatório

Indica se as definições de propriedade devem ser incluídas na resposta.

inputs
string[]
obrigatório

Resposta

successful operation

results
object[]
obrigatório
Last modified on April 13, 2026