> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: 96297564-f457-4d27-a765-d2efc303f698
---
# Get all schemas
> Retrieve the schemas associated with a specific app in the HubSpot account. This endpoint allows you to fetch schema details, which can be useful for understanding the data structure and properties associated with the app. You can optionally filter the results to include only archived schemas.
export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, crm, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel, crmLevel}) => {
const translations = {
description: "Requires one of the following products or higher.",
productNames: {
marketing: "Marketing Hub",
sales: "Sales Hub",
service: "Service Hub",
cms: "Content Hub",
data: "Data Hub",
commerce: "Revenue Hub",
crm: "Smart CRM"
},
tiers: {
free: "Free",
starter: "Starter",
professional: "Professional",
enterprise: "Enterprise"
}
};
const translateTier = tier => {
if (!tier) return '';
const lowerTier = tier.toLowerCase();
return translations.tiers[lowerTier] || tier;
};
const products = [{
name: marketing ? translations.productNames.marketing : '',
level: translateTier(marketingLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/MarketingHub.svg",
alt: "Marketing Hub"
}, {
name: sales ? translations.productNames.sales : '',
level: translateTier(salesLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SalesHub.svg",
alt: "Sales Hub"
}, {
name: service ? translations.productNames.service : '',
level: translateTier(serviceLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ServiceHub.svg",
alt: "Service Hub"
}, {
name: cms ? translations.productNames.cms : '',
level: translateTier(cmsLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/ContentHub.svg",
alt: "Content Hub"
}, {
name: data ? translations.productNames.data : '',
level: translateTier(dataLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/DataHub.svg",
alt: "Data Hub"
}, {
name: commerce ? translations.productNames.commerce : '',
level: translateTier(commerceLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
alt: "Revenue Hub"
}, {
name: crm ? translations.productNames.crm : '',
level: translateTier(crmLevel),
icon: "https://www.hubspot.com/hubfs/Knowledge_Base_2023-24-25/developer/icons/SmartCRM.svg",
alt: "Smart CRM"
}].filter(product => product.name && product.level);
if (products.length === 0) return null;
return
{translations.description}
{products.map((product, index) =>
{product.name} -{product.level}
)}
;
};
## OpenAPI
````yaml specs/2026-03/cms-media-bridge-v2026-03.json GET /media-bridge/2026-03/{appId}/schemas
openapi: 3.0.1
info:
title: CMS Media Bridge
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Basic
- name: Batch
paths:
/media-bridge/2026-03/{appId}/schemas:
get:
tags:
- Basic
summary: Retrieve schemas
description: >-
Retrieve the schemas associated with a specific app in the HubSpot
account. This endpoint allows you to fetch schema details, which can be
useful for understanding the data structure and properties associated
with the app. You can optionally filter the results to include only
archived schemas.
operationId: get-/media-bridge/2026-03/{appId}/schemas
parameters:
- name: appId
in: path
description: ''
required: true
style: simple
explode: false
schema:
type: integer
format: int32
- name: archived
in: query
description: Whether to return only results that have been archived.
required: false
style: form
explode: true
schema:
type: boolean
default: false
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionResponseObjectSchemaNoPaging'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- developers-read
components:
schemas:
CollectionResponseObjectSchemaNoPaging:
required:
- results
type: object
properties:
results:
type: array
description: >-
An array of object schemas included in the response. Each item in
the array is an object schema.
items:
$ref: '#/components/schemas/ObjectSchema'
ObjectSchema:
required:
- allowsSensitiveProperties
- archived
- associations
- fullyQualifiedName
- id
- labels
- name
- objectTypeId
- properties
- requiredProperties
- searchableProperties
- secondaryDisplayProperties
type: object
properties:
allowsSensitiveProperties:
type: boolean
description: A boolean indicating whether the object allows sensitive properties.
archived:
type: boolean
description: A boolean indicating whether the object is archived.
associations:
type: array
description: >-
A reference to the associations of the object, which are defined
elsewhere in the schema.
items:
$ref: '#/components/schemas/AssociationDefinition'
createdAt:
type: string
description: A string in date-time format indicating when the object was created.
format: date-time
createdByUserId:
type: integer
description: A string representing the ID of the user who created the object.
format: int32
description:
type: string
description: A string providing a description of the object.
fullyQualifiedName:
type: string
description: A string representing the fully qualified name of the object.
id:
type: string
description: A string representing the unique identifier of the object.
labels:
$ref: '#/components/schemas/ObjectTypeDefinitionLabels'
name:
type: string
description: A string representing the name of the object.
objectTypeId:
type: string
description: A string representing the type identifier of the object.
primaryDisplayProperty:
type: string
description: >-
A string representing the primary property used for displaying the
object.
properties:
type: array
description: >-
A reference to the properties of the object, which are defined
elsewhere in the schema.
items:
$ref: '#/components/schemas/Property_1'
requiredProperties:
type: array
description: >-
An array of strings representing the properties that are required
for the object.
items:
type: string
searchableProperties:
type: array
description: >-
An array of strings indicating which properties of the object are
searchable.
items:
type: string
secondaryDisplayProperties:
type: array
description: >-
An array of strings representing additional properties used for
displaying the object.
items:
type: string
updatedAt:
type: string
description: >-
A string in date-time format indicating when the object was last
updated.
format: date-time
updatedByUserId:
type: integer
description: >-
A string representing the ID of the user who last updated the
object.
format: int32
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request. Include this value with any
error reports or support tickets
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: further information about the error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
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
AssociationDefinition:
required:
- fromObjectTypeId
- id
- toObjectTypeId
type: object
properties:
createdAt:
type: string
description: >-
The date and time when this association definition was created, in
ISO 8601 format.
format: date-time
fromObjectTypeId:
type: string
description: >-
The unique identifier of the object type from which the association
originates.
id:
type: string
description: The unique identifier for this association definition.
name:
type: string
description: >-
The name of the association, which serves as a human-readable
identifier.
toObjectTypeId:
type: string
description: >-
The unique identifier of the object type to which the association
points.
updatedAt:
type: string
description: >-
The date and time when this association definition was last updated,
in ISO 8601 format.
format: date-time
description: The definition of an association
ObjectTypeDefinitionLabels:
type: object
properties:
plural:
type: string
description: >-
The plural label for the object type, used to represent multiple
instances of the object. It is a string.
singular:
type: string
description: >-
The singular label for the object type, used to represent a single
instance of the object. It is a string.
Property_1:
required:
- description
- fieldType
- groupName
- label
- name
- options
- type
type: object
properties:
archived:
type: boolean
description: A boolean indicating whether the property is archived.
archivedAt:
type: string
description: >-
The date and time when the property was archived, in ISO 8601
format.
format: date-time
calculated:
type: boolean
description: A boolean indicating whether the property is calculated.
calculationFormula:
type: string
description: The formula used for calculating the property value, if applicable.
createdAt:
type: string
description: The date and time when the property was created, in ISO 8601 format.
format: date-time
createdUserId:
type: string
description: The ID of the user who created the property.
currencyPropertyName:
type: string
description: The name of the currency property associated with this property.
dataSensitivity:
type: string
description: The sensitivity level of the data contained in the property.
enum:
- highly_sensitive
- non_sensitive
- sensitive
dateDisplayHint:
type: string
description: A hint for displaying date properties.
enum:
- absolute
- absolute_with_relative
- time_since
- time_until
description:
type: string
description: A description of the property.
displayOrder:
type: integer
description: An integer indicating the display order of the property.
format: int32
externalOptions:
type: boolean
description: A boolean indicating whether the property options are external.
fieldType:
type: string
description: >-
The field type of the property, which can be one of
'booleancheckbox', 'calculation_equation', 'checkbox', 'date',
'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text',
or 'textarea'.
formField:
type: boolean
description: A boolean indicating whether the property is a form field.
groupName:
type: string
description: The name of the group to which the property belongs.
hasUniqueValue:
type: boolean
description: A boolean indicating whether the property value is unique.
hidden:
type: boolean
description: A boolean indicating whether the property is hidden.
hubspotDefined:
type: boolean
description: A boolean indicating whether the property is defined by HubSpot.
label:
type: string
description: The display label for the property.
modificationMetadata:
$ref: '#/components/schemas/PropertyModificationMetadata'
name:
type: string
description: The unique name of the property.
numberDisplayHint:
type: string
description: >-
A hint for displaying number properties, which can be 'unformatted',
'formatted', 'currency', 'percentage', 'duration', or 'probability'.
enum:
- currency
- duration
- formatted
- percentage
- probability
- unformatted
options:
type: array
description: >-
An array of options available for the property, applicable if the
property type is 'enumeration'.
items:
$ref: '#/components/schemas/Option_1'
referencedObjectType:
type: string
description: The object type that the property references, if applicable.
sensitiveDataCategories:
type: array
description: Categories of sensitive data associated with the property.
items:
type: string
showCurrencySymbol:
type: boolean
description: >-
A boolean indicating whether to show the currency symbol for the
property.
textDisplayHint:
type: string
description: >-
A hint for displaying text properties, which can be
'unformatted_single_line', 'multi_line', 'email', 'phone_number',
'domain_name', 'ip_address', 'physical_address', or 'postal_code'.
enum:
- domain_name
- email
- ip_address
- multi_line
- phone_number
- physical_address
- postal_code
- unformatted_single_line
type:
type: string
description: >-
The data type of the property, such as 'bool', 'date', 'datetime',
'enumeration', 'number', 'phone_number', or 'string'.
updatedAt:
type: string
description: >-
The date and time when the property was last updated, in ISO 8601
format.
format: date-time
updatedUserId:
type: string
description: The ID of the user who last updated the property.
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Context about the error condition
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: The name of the field or parameter in which the error was found.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
PropertyModificationMetadata:
required:
- archivable
- readOnlyDefinition
- readOnlyValue
type: object
properties:
archivable:
type: boolean
description: A boolean indicating whether the property can be archived.
readOnlyDefinition:
type: boolean
description: >-
A boolean indicating if the property's definition is read-only,
meaning it cannot be modified.
readOnlyOptions:
type: boolean
description: A boolean indicating if the options for the property are read-only.
readOnlyValue:
type: boolean
description: >-
A boolean indicating if the property's value is read-only, meaning
it cannot be changed.
Option_1:
required:
- hidden
- label
- value
type: object
properties:
description:
type: string
description: A string providing additional information about the option.
displayOrder:
type: integer
description: >-
An integer indicating the order in which the option should be
displayed relative to other options.
format: int32
hidden:
type: boolean
description: A boolean indicating whether the option is hidden from display.
label:
type: string
description: A string representing the display label for the option.
value:
type: string
description: A string representing the value assigned to the option.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
developers-read: ''
developers-write: ''
media_bridge.write: ''
````
{product.name} -
{product.level}
)}