Pular para o conteúdo principal
GET
/
media-bridge
/
v1
/
{appId}
/
schemas
/
{objectType}
Obter o esquema para um tipo de objeto
curl --request GET \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}?hapikey='
{
  "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>",
      "dataSensitivity": "highly_sensitive",
      "dateDisplayHint": "absolute",
      "displayOrder": 123,
      "externalOptions": true,
      "formField": true,
      "hasUniqueValue": true,
      "hidden": true,
      "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
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

Autorizações

hapikey
string
query
obrigatório

Parâmetros de caminho

appId
integer<int32>
obrigatório

O appId do aplicativo Media Bridge. É possível ter vários aplicativos na sua conta de desenvolvedor que usam a Media Bridge.

objectType
string
obrigatório

O tipo de objeto para o qual obter o esquema.

Resposta

successful operation

allowsSensitiveProperties
boolean
obrigatório
archived
boolean
obrigatório
associations
object[]
obrigatório
fullyQualifiedName
string
obrigatório
id
string
obrigatório
labels
object
obrigatório
name
string
obrigatório
objectTypeId
string
obrigatório
properties
object[]
obrigatório
requiredProperties
string[]
obrigatório
searchableProperties
string[]
obrigatório
secondaryDisplayProperties
string[]
obrigatório
createdAt
string<date-time>
createdByUserId
integer<int32>
description
string
primaryDisplayProperty
string
updatedAt
string<date-time>
updatedByUserId
integer<int32>
Last modified on January 23, 2026