curl --request GET \
--url 'https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey='import requests
url = "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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": {
"includeHelpdeskRoutableTeamsOnly": true,
"includeUnconfirmedUsers": true,
"listProcessingTypes": [
"<string>"
],
"pipelineIds": [
"<string>"
],
"teamIds": [
"<string>"
]
},
"fromObjectId": 123,
"propertyName": "<string>",
"relatedObjectTypeId": "<string>"
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"janusGroup": "<string>",
"lookupAssociationSpec": {
"associationSpec": {
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 123
},
"cardinality": "ONE_TO_MANY",
"maxToObjectIds": 123,
"toObjectTypeId": "<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>",
"objectTypeIdString": "<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",
"visibilities": [
"Customer-facing"
],
"visibility": "Customer-facing",
"writeScopeName": "<string>"
}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Get object types for a supported media
Recupere as definições de objeto para um tipo de mídia especificado em um aplicativo. Este endpoint permite acessar as configurações relacionadas às definições de objeto de vários tipos de mídia, como VIDEO, AUDIO, DOCUMENT, OTHER e IMAGE. É útil para entender a estrutura e as propriedades associadas a diferentes tipos de mídia em seu aplicativo.
curl --request GET \
--url 'https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey='import requests
url = "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey="
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/media-bridge/2026-09/{appId}/settings/object-definitions/{mediaType}?hapikey=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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": {
"includeHelpdeskRoutableTeamsOnly": true,
"includeUnconfirmedUsers": true,
"listProcessingTypes": [
"<string>"
],
"pipelineIds": [
"<string>"
],
"teamIds": [
"<string>"
]
},
"fromObjectId": 123,
"propertyName": "<string>",
"relatedObjectTypeId": "<string>"
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"janusGroup": "<string>",
"lookupAssociationSpec": {
"associationSpec": {
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 123
},
"cardinality": "ONE_TO_MANY",
"maxToObjectIds": 123,
"toObjectTypeId": "<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>",
"objectTypeIdString": "<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",
"visibilities": [
"Customer-facing"
],
"visibility": "Customer-facing",
"writeScopeName": "<string>"
}
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Autorizações
Parâmetros de caminho
O identificador exclusivo do aplicativo para o qual as configurações estão sendo recuperadas.
O tipo de mídia para o qual as definições de objeto estão sendo recuperadas. Os valores válidos são VIDEO, AUDIO, DOCUMENT, OTHER e IMAGE.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO Parâmetros de consulta
Um booleano que indica se a definição completa do objeto deve ser incluída. Se não for especificado, o comportamento padrão é retornar uma definição parcial.
Resposta
successful operation
Uma string que representa o identificador exclusivo para o tipo de objeto.
Uma string que representa o nome do tipo de objeto.
Uma matriz de propriedades que pertencem ao tipo de objeto, cada uma definindo atributos específicos do objeto.
Show child attributes
Show child attributes
Uma matriz de grupos de propriedades associados ao tipo de objeto, detalhando como as propriedades são agrupadas.
Show child attributes
Show child attributes
Show child attributes
Show child attributes