Zum Hauptinhalt springen
GET
/
media-bridge
/
v1
/
{appId}
/
schemas
/
{objectType}
Get the schema for an object type
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
}

Supported products

Autorisierungen

hapikey
string
query
erforderlich

Pfadparameter

appId
integer<int32>
erforderlich

The appId for the media bridge app. It is possible to have multiple apps in your developer account that use the media bridge.

objectType
string
erforderlich

The object type to get the schema for.

Antwort

successful operation

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