Pular para o conteúdo principal
GET
/
media-bridge
/
v1
/
{appId}
/
settings
/
object-definitions
/
{mediaType}
Obter tipos de objetos para uma mídia suportada
curl --request GET \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}?hapikey='
{
  "objectTypeId": "<string>",
  "objectTypeName": "<string>",
  "properties": [
    {
      "objectTypeId": "<string>",
      "property": {
        "allowedObjectTypes": [
          {
            "innerId": 123,
            "metaTypeId": 123
          }
        ],
        "calculated": true,
        "canArchive": true,
        "canRestore": true,
        "createdAt": 123,
        "createdUserId": 123,
        "currencyPropertyName": "<string>",
        "dataSensitivity": "high",
        "dateDisplayHint": "absolute",
        "deleted": true,
        "description": "<string>",
        "displayMode": "all_unique_versions",
        "displayOrder": 123,
        "enforceMultivalueUniqueness": true,
        "externalOptions": true,
        "externalOptionsReferenceType": "<string>",
        "favorited": true,
        "favoritedOrder": 123,
        "fieldType": "<string>",
        "formField": true,
        "fromUserId": 123,
        "groupName": "<string>",
        "hasUniqueValue": true,
        "hidden": false,
        "hubspotDefined": true,
        "isCustomizedDefault": true,
        "isMultiValued": true,
        "isPartial": true,
        "label": "<string>",
        "mutableDefinitionNotDeletable": true,
        "name": "<string>",
        "numberDisplayHint": "currency",
        "optionSortStrategy": "ALPHABETICAL",
        "options": [
          {
            "description": "<string>",
            "displayOrder": 123,
            "doubleData": 123,
            "hidden": true,
            "label": "<string>",
            "readOnly": true,
            "value": "<string>"
          }
        ],
        "optionsAreMutable": true,
        "owningAppId": 123,
        "portalId": 123,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "referencedObjectType": "ABANDONED_CART",
        "searchTextAnalysisMode": "NONE",
        "searchableInGlobalSearch": true,
        "sensitiveDataCategories": [
          "<string>"
        ],
        "showCurrencySymbol": true,
        "textDisplayHint": "domain_name",
        "type": "bool",
        "updatedAt": 123
      },
      "calculationExpression": {
        "operator": "CONSTANT_BOOLEAN",
        "propertyName": "<string>",
        "value": true
      },
      "calculationFormula": "<string>",
      "definitionSource": {
        "type": "GLOBAL",
        "name": "<string>"
      },
      "extensionData": {
        "extensionStatusMap": {},
        "tags": [
          "<string>"
        ],
        "caseChangeTestExtensionData": {
          "mood": "ANGRY"
        },
        "optionDecoratorsExtensionData": {
          "optionDecoratorStyle": "LABEL_ONLY",
          "optionDecorators": {}
        },
        "requiredPropertiesExtensionData": {
          "isRequiredProperty": true
        },
        "softRequiredPropertiesExtensionData": {
          "isSoftRequiredProperty": true
        }
      },
      "externalOptionsMetaData": {
        "filter": {
          "includeUnconfirmedUsers": true,
          "pipelineIds": [
            "<string>"
          ],
          "includeHelpdeskRoutableTeamsOnly": true,
          "listProcessingTypes": [
            "<string>"
          ]
        },
        "relatedObjectTypeId": "<string>"
      },
      "fulcrumPortalId": 123,
      "fulcrumTimestamp": 123,
      "janusGroup": "<string>",
      "permission": {
        "accessLevel": "<string>"
      },
      "propertyDefinitionSource": {
        "type": "GLOBAL",
        "name": "<string>"
      },
      "propertyRequirements": {
        "gates": [
          "<string>"
        ],
        "operator": "AND",
        "scopeNames": [
          "<string>"
        ],
        "settings": [
          "<string>"
        ]
      },
      "rollupExpression": {
        "associationTypes": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 123
          }
        ],
        "rollupOperator": "AVERAGE",
        "sourceObjectTypeId": "<string>",
        "sourcePropertyName": "<string>",
        "conditionalExpression": {
          "operator": "CONSTANT_BOOLEAN",
          "propertyName": "<string>",
          "value": true
        },
        "conditionalFormula": "<string>",
        "emptyRollupValue": "<string>",
        "sourceCompareByPropertyName": "<string>"
      }
    }
  ],
  "propertyGroups": [
    {
      "displayName": "<string>",
      "displayOrder": 123,
      "fulcrumPortalId": 123,
      "fulcrumTimestamp": 123,
      "hubspotDefined": true,
      "name": "<string>"
    }
  ],
  "schema": {
    "allowsSensitiveProperties": true,
    "createDatePropertyName": "<string>",
    "defaultSearchPropertyNames": [
      "<string>"
    ],
    "deleted": true,
    "fullyQualifiedName": "<string>",
    "hasCustomProperties": true,
    "hasDefaultProperties": true,
    "hasExternalObjectIds": true,
    "hasOwners": true,
    "hasPipelines": true,
    "id": 123,
    "indexedForFiltersAndReports": true,
    "lastModifiedPropertyName": "<string>",
    "metaType": "CMS_HUBDB",
    "metaTypeId": 123,
    "name": "<string>",
    "objectTypeId": "<string>",
    "permissioningType": "ALL_OR_NONE",
    "pipelinePropertyName": "<string>",
    "pipelineStagePropertyName": "<string>",
    "requiredProperties": [
      "<string>"
    ],
    "restorable": true,
    "scopeMappings": [
      {
        "accessLevel": "ALL",
        "requestAction": "COMMUNICATE",
        "scopeName": "<string>"
      }
    ],
    "secondaryDisplayLabelPropertyNames": [
      "<string>"
    ],
    "accessScopeName": "<string>",
    "createdAt": 123,
    "description": "<string>",
    "integrationAppId": 123,
    "janusGroup": "<string>",
    "ownerPortalId": 123,
    "pipelineCloseDatePropertyName": "<string>",
    "pipelineTimeToClosePropertyName": "<string>",
    "pluralForm": "<string>",
    "primaryDisplayLabelPropertyName": "<string>",
    "readScopeName": "<string>",
    "singularForm": "<string>",
    "status": "Deprecated",
    "visibility": "Customer-facing",
    "writeScopeName": "<string>"
  }
}
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.

mediaType
enum<string>
obrigatório

O tipo de mídia para o qual você deseja obter os tipos de objeto.

Opções disponíveis:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO

Parâmetros de consulta

includeFullDefinition
boolean

Inclua a definição completa na resposta.

Resposta

successful operation

objectTypeId
string
obrigatório
objectTypeName
string
obrigatório
properties
object[]
obrigatório
propertyGroups
object[]
obrigatório
schema
object
Last modified on January 23, 2026