curl --request GET \
--url https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}
{
"schema": {
"hasOwners": true,
"permissioningType": "<string>",
"primaryDisplayLabelPropertyName": "<string>",
"objectTypeId": "<string>",
"lastModifiedPropertyName": "<string>",
"integrationAppId": 123,
"description": "<string>",
"allowsSensitiveProperties": true,
"pipelinePropertyName": "<string>",
"pipelineTimeToClosePropertyName": "<string>",
"singularForm": "<string>",
"createdAt": 123,
"hasPipelines": true,
"hasExternalObjectIds": true,
"scopeMappings": [
{
"accessLevel": "<string>",
"requestAction": "<string>",
"scopeName": "<string>"
}
],
"hasDefaultProperties": true,
"indexedForFiltersAndReports": true,
"createDatePropertyName": "<string>",
"id": 123,
"ownerPortalId": 123,
"restorable": true,
"pluralForm": "<string>",
"metaTypeId": 123,
"defaultSearchPropertyNames": [
"<string>"
],
"visibility": "<string>",
"janusGroup": "<string>",
"pipelineCloseDatePropertyName": "<string>",
"fullyQualifiedName": "<string>",
"deleted": true,
"requiredProperties": [
"<string>"
],
"writeScopeName": "<string>",
"accessScopeName": "<string>",
"hasCustomProperties": true,
"name": "<string>",
"metaType": "HUBSPOT",
"pipelineStagePropertyName": "<string>",
"readScopeName": "<string>",
"secondaryDisplayLabelPropertyNames": [
"<string>"
],
"status": "<string>"
},
"objectTypeId": "<string>",
"objectTypeName": "<string>",
"properties": [
{
"objectTypeId": "<string>",
"janusGroup": "<string>",
"propertyRequirements": {
"gates": [
"<string>"
],
"settings": [
"<string>"
],
"scopeNames": [
"<string>"
],
"operator": "AND"
},
"definitionSource": {
"name": "<string>",
"type": "GLOBAL"
},
"externalOptionsMetaData": {
"filter": {
"pipelineIds": [
"<string>"
],
"includeUnconfirmedUsers": true
},
"relatedObjectTypeId": "<string>"
},
"permission": {
"accessLevel": "<string>"
},
"calculationExpression": "<any>",
"rollupExpression": {
"associationTypes": [
{
"associationCategory": "",
"associationTypeId": 123
}
],
"emptyRollupValue": "<string>",
"conditionalFormula": "<string>",
"sourceObjectTypeId": "<string>",
"conditionalExpression": "<any>",
"rollupOperator": "<string>",
"sourcePropertyName": "<string>",
"sourceCompareByPropertyName": "<string>"
},
"extensionData": {
"softRequiredPropertiesExtensionData": {
"isSoftRequiredProperty": true
},
"extensionStatusMap": {},
"caseChangeTestExtensionData": {
"mood": "<string>"
},
"optionDecoratorsExtensionData": {
"optionDecoratorStyle": "<string>",
"optionDecorators": {}
},
"tags": [
"<string>"
],
"requiredPropertiesExtensionData": {
"isRequiredProperty": true
}
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"propertyDefinitionSource": {
"name": "<string>",
"type": "<string>"
},
"property": {
"favoritedOrder": 123,
"enforceMultivalueUniqueness": true,
"readOnlyValue": false,
"hidden": false,
"optionSortStrategy": "",
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"readOnlyDefinition": false,
"hubspotDefined": false,
"allowedObjectTypes": "",
"createdAt": 123,
"searchTextAnalysisMode": "NONE",
"textDisplayHint": "",
"portalId": 123,
"options": "",
"isPartial": false,
"optionsAreMutable": false,
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"dateDisplayHint": "absolute",
"favorited": false,
"updatedAt": 123,
"createdUserId": 123,
"canArchive": true,
"fromUserId": 123,
"mutableDefinitionNotDeletable": false,
"isMultiValued": false,
"sensitiveDataCategories": "",
"canRestore": true,
"currencyPropertyName": "",
"owningAppId": 123,
"isCustomizedDefault": false,
"label": "",
"formField": false,
"displayMode": "",
"dataSensitivity": "",
"groupName": "",
"deleted": false,
"referencedObjectType": "",
"name": "",
"searchableInGlobalSearch": false,
"externalOptionsReferenceType": "",
"numberDisplayHint": "",
"fieldType": ""
},
"calculationFormula": "<string>"
}
],
"propertyGroups": [
{
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"displayName": "<string>",
"name": "<string>",
"displayOrder": 123,
"hubspotDefined": true
}
]
}
Get the existing objects types that belong to the specified media type.
curl --request GET \
--url https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}
{
"schema": {
"hasOwners": true,
"permissioningType": "<string>",
"primaryDisplayLabelPropertyName": "<string>",
"objectTypeId": "<string>",
"lastModifiedPropertyName": "<string>",
"integrationAppId": 123,
"description": "<string>",
"allowsSensitiveProperties": true,
"pipelinePropertyName": "<string>",
"pipelineTimeToClosePropertyName": "<string>",
"singularForm": "<string>",
"createdAt": 123,
"hasPipelines": true,
"hasExternalObjectIds": true,
"scopeMappings": [
{
"accessLevel": "<string>",
"requestAction": "<string>",
"scopeName": "<string>"
}
],
"hasDefaultProperties": true,
"indexedForFiltersAndReports": true,
"createDatePropertyName": "<string>",
"id": 123,
"ownerPortalId": 123,
"restorable": true,
"pluralForm": "<string>",
"metaTypeId": 123,
"defaultSearchPropertyNames": [
"<string>"
],
"visibility": "<string>",
"janusGroup": "<string>",
"pipelineCloseDatePropertyName": "<string>",
"fullyQualifiedName": "<string>",
"deleted": true,
"requiredProperties": [
"<string>"
],
"writeScopeName": "<string>",
"accessScopeName": "<string>",
"hasCustomProperties": true,
"name": "<string>",
"metaType": "HUBSPOT",
"pipelineStagePropertyName": "<string>",
"readScopeName": "<string>",
"secondaryDisplayLabelPropertyNames": [
"<string>"
],
"status": "<string>"
},
"objectTypeId": "<string>",
"objectTypeName": "<string>",
"properties": [
{
"objectTypeId": "<string>",
"janusGroup": "<string>",
"propertyRequirements": {
"gates": [
"<string>"
],
"settings": [
"<string>"
],
"scopeNames": [
"<string>"
],
"operator": "AND"
},
"definitionSource": {
"name": "<string>",
"type": "GLOBAL"
},
"externalOptionsMetaData": {
"filter": {
"pipelineIds": [
"<string>"
],
"includeUnconfirmedUsers": true
},
"relatedObjectTypeId": "<string>"
},
"permission": {
"accessLevel": "<string>"
},
"calculationExpression": "<any>",
"rollupExpression": {
"associationTypes": [
{
"associationCategory": "",
"associationTypeId": 123
}
],
"emptyRollupValue": "<string>",
"conditionalFormula": "<string>",
"sourceObjectTypeId": "<string>",
"conditionalExpression": "<any>",
"rollupOperator": "<string>",
"sourcePropertyName": "<string>",
"sourceCompareByPropertyName": "<string>"
},
"extensionData": {
"softRequiredPropertiesExtensionData": {
"isSoftRequiredProperty": true
},
"extensionStatusMap": {},
"caseChangeTestExtensionData": {
"mood": "<string>"
},
"optionDecoratorsExtensionData": {
"optionDecoratorStyle": "<string>",
"optionDecorators": {}
},
"tags": [
"<string>"
],
"requiredPropertiesExtensionData": {
"isRequiredProperty": true
}
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"propertyDefinitionSource": {
"name": "<string>",
"type": "<string>"
},
"property": {
"favoritedOrder": 123,
"enforceMultivalueUniqueness": true,
"readOnlyValue": false,
"hidden": false,
"optionSortStrategy": "",
"displayOrder": 123,
"description": "",
"showCurrencySymbol": false,
"type": "",
"readOnlyDefinition": false,
"hubspotDefined": false,
"allowedObjectTypes": "",
"createdAt": 123,
"searchTextAnalysisMode": "NONE",
"textDisplayHint": "",
"portalId": 123,
"options": "",
"isPartial": false,
"optionsAreMutable": false,
"hasUniqueValue": false,
"calculated": false,
"externalOptions": false,
"dateDisplayHint": "absolute",
"favorited": false,
"updatedAt": 123,
"createdUserId": 123,
"canArchive": true,
"fromUserId": 123,
"mutableDefinitionNotDeletable": false,
"isMultiValued": false,
"sensitiveDataCategories": "",
"canRestore": true,
"currencyPropertyName": "",
"owningAppId": 123,
"isCustomizedDefault": false,
"label": "",
"formField": false,
"displayMode": "",
"dataSensitivity": "",
"groupName": "",
"deleted": false,
"referencedObjectType": "",
"name": "",
"searchableInGlobalSearch": false,
"externalOptionsReferenceType": "",
"numberDisplayHint": "",
"fieldType": ""
},
"calculationFormula": "<string>"
}
],
"propertyGroups": [
{
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"displayName": "<string>",
"name": "<string>",
"displayOrder": 123,
"hubspotDefined": true
}
]
}
successful operation
The response is of type object
.
Was this page helpful?