Passer au contenu principal
GET
/
media-bridge
/
v1
/
{appId}
/
settings
/
object-definitions
/
{mediaType}
Obtenir les types d'objets pour un média pris en charge
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",
        "inputs": [
          {
            "operator": "CONSTANT_NUMBER",
            "inputs": "<array>",
            "propertyName": "<string>",
            "value": 123
          }
        ],
        "propertyName": "<string>",
        "value": true
      },
      "calculationFormula": "<string>",
      "definitionSource": {
        "type": "GLOBAL",
        "name": "<string>"
      },
      "extensionData": {
        "extensionStatusMap": {},
        "tags": [
          "<string>"
        ],
        "caseChangeTestExtensionData": {
          "mood": "<string>"
        },
        "optionDecoratorsExtensionData": {
          "optionDecoratorStyle": "<string>",
          "optionDecorators": {}
        },
        "requiredPropertiesExtensionData": {
          "isRequiredProperty": true
        },
        "softRequiredPropertiesExtensionData": {
          "isSoftRequiredProperty": true
        }
      },
      "externalOptionsMetaData": {
        "filter": {
          "includeUnconfirmedUsers": true,
          "pipelineIds": [
            "<string>"
          ]
        },
        "relatedObjectTypeId": "<string>"
      },
      "fulcrumPortalId": 123,
      "fulcrumTimestamp": 123,
      "janusGroup": "<string>",
      "permission": {
        "accessLevel": "<string>"
      },
      "propertyDefinitionSource": {
        "type": "<string>",
        "name": "<string>"
      },
      "propertyRequirements": {
        "gates": [
          "<string>"
        ],
        "operator": "AND",
        "scopeNames": [
          "<string>"
        ],
        "settings": [
          "<string>"
        ]
      },
      "rollupExpression": {
        "associationTypes": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 123
          }
        ],
        "rollupOperator": "<string>",
        "sourceObjectTypeId": "<string>",
        "sourcePropertyName": "<string>",
        "conditionalExpression": {
          "operator": "CONSTANT_BOOLEAN",
          "inputs": [
            {
              "operator": "CONSTANT_NUMBER",
              "inputs": "<array>",
              "propertyName": "<string>",
              "value": 123
            }
          ],
          "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": "<string>",
    "pipelinePropertyName": "<string>",
    "pipelineStagePropertyName": "<string>",
    "requiredProperties": [
      "<string>"
    ],
    "restorable": true,
    "scopeMappings": [
      {
        "accessLevel": "<string>",
        "requestAction": "<string>",
        "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": "<string>",
    "visibility": "<string>",
    "writeScopeName": "<string>"
  }
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubGratuit

Autorisations

hapikey
string
query
requis

Paramètres de chemin

appId
integer<int32>
requis

L'appId de l'application Media Bridge. Il est possible d'avoir plusieurs applications dans votre compte développeur qui utilisent le Media Bridge.

mediaType
enum<string>
requis

Le type de média pour lequel vous souhaitez obtenir les types d'objets.

Options disponibles:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO

Paramètres de requête

includeFullDefinition
boolean

Inclure la définition complète dans la réponse.

Réponse

successful operation

objectTypeId
string
requis
objectTypeName
string
requis
properties
object[]
requis
propertyGroups
object[]
requis
schema
object
Last modified on September 3, 2025