--- title: "Retrieve schemas" method: GET path: "/media-bridge/2026-09/{appId}/schemas" tags: ["Basic"] --- # Retrieve schemas `GET /media-bridge/2026-09/{appId}/schemas` ## Request - Base URL: `https://api.hubapi.com` - URL: `https://api.hubapi.com/media-bridge/2026-09/{appId}/schemas` - Auth: API key in query parameter `hapikey` 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. ## Path parameters - `appId` integer, required ## Query parameters - `archived` boolean ## Response `200` successful operation - CollectionResponseObjectSchemaNoPaging - `results` ObjectSchema[], required: An array of object schemas included in the response. Each item in the array is an object schema. - `allowsSensitiveProperties` boolean, required: A boolean indicating whether the object allows sensitive properties. - `archived` boolean, required: A boolean indicating whether the object is archived. - `associations` AssociationDefinition[], required: A reference to the associations of the object, which are defined elsewhere in the schema. - `createdAt` string, date-time: The date and time when this association definition was created, in ISO 8601 format. - `fromObjectTypeId` string, required: The unique identifier of the object type from which the association originates. - `id` string, required: The unique identifier for this association definition. - `name` string: The name of the association, which serves as a human-readable identifier. - `toObjectTypeId` string, required: The unique identifier of the object type to which the association points. - `updatedAt` string, date-time: The date and time when this association definition was last updated, in ISO 8601 format. - `createdAt` string, date-time: A string in date-time format indicating when the object was created. - `createdByUserId` integer: A string representing the ID of the user who created the object. - `description` string: A string providing a description of the object. - `fullyQualifiedName` string, required: A string representing the fully qualified name of the object. - `id` string, required: A string representing the unique identifier of the object. - `labels` ObjectTypeDefinitionLabels, required - `plural` string: The plural label for the object type, used to represent multiple instances of the object. It is a string. - `singular` string: The singular label for the object type, used to represent a single instance of the object. It is a string. - `name` string, required: A string representing the name of the object. - `objectTypeId` string, required: A string representing the type identifier of the object. - `primaryDisplayProperty` string: A string representing the primary property used for displaying the object. - `properties` Property1[], required: A reference to the properties of the object, which are defined elsewhere in the schema. - `archived` boolean: A boolean indicating whether the property is archived. - `archivedAt` string, date-time: The date and time when the property was archived, in ISO 8601 format. - `calculated` boolean: A boolean indicating whether the property is calculated. - `calculationFormula` string: The formula used for calculating the property value, if applicable. - `createdAt` string, date-time: The date and time when the property was created, in ISO 8601 format. - `createdUserId` string: The ID of the user who created the property. - `currencyPropertyName` string: The name of the currency property associated with this property. - `dataSensitivity` 'highly_sensitive' | 'non_sensitive' | 'sensitive': The sensitivity level of the data contained in the property. - `dateDisplayHint` 'absolute' | 'absolute_with_relative' | 'time_since' | 'time_until': A hint for displaying date properties. - `description` string, required: A description of the property. - `displayOrder` integer: An integer indicating the display order of the property. - `externalOptions` boolean: A boolean indicating whether the property options are external. - `fieldType` string, required: 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` boolean: A boolean indicating whether the property is a form field. - `groupName` string, required: The name of the group to which the property belongs. - `hasUniqueValue` boolean: A boolean indicating whether the property value is unique. - `hidden` boolean: A boolean indicating whether the property is hidden. - `hubspotDefined` boolean: A boolean indicating whether the property is defined by HubSpot. - `label` string, required: The display label for the property. - `modificationMetadata` PropertyModificationMetadata - `archivable` boolean, required: A boolean indicating whether the property can be archived. - `readOnlyDefinition` boolean, required: A boolean indicating if the property's definition is read-only, meaning it cannot be modified. - `readOnlyOptions` boolean: A boolean indicating if the options for the property are read-only. - `readOnlyValue` boolean, required: A boolean indicating if the property's value is read-only, meaning it cannot be changed. - `name` string, required: The unique name of the property. - `numberDisplayHint` 'currency' | 'duration' | 'formatted' | 'percentage' | 'probability' | 'unformatted': A hint for displaying number properties, which can be 'unformatted', 'formatted', 'currency', 'percentage', 'duration', or 'probability'. - `options` Option1[], required: An array of options available for the property, applicable if the property type is 'enumeration'. - `description` string: A string providing additional information about the option. - `displayOrder` integer: An integer indicating the order in which the option should be displayed relative to other options. - `hidden` boolean, required: A boolean indicating whether the option is hidden from display. - `label` string, required: A string representing the display label for the option. - `value` string, required: A string representing the value assigned to the option. - `referencedObjectType` string: The object type that the property references, if applicable. - `sensitiveDataCategories` string[]: Categories of sensitive data associated with the property. - `showCurrencySymbol` boolean: A boolean indicating whether to show the currency symbol for the property. - `textDisplayHint` 'domain_name' | 'email' | 'ip_address' | 'multi_line' | 'phone_number' | 'physical_address' | 'postal_code' | 'unformatted_single_line': 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'. - `type` string, required: The data type of the property, such as 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number', or 'string'. - `updatedAt` string, date-time: The date and time when the property was last updated, in ISO 8601 format. - `updatedUserId` string: The ID of the user who last updated the property. - `requiredProperties` string[], required: An array of strings representing the properties that are required for the object. - `searchableProperties` string[], required: An array of strings indicating which properties of the object are searchable. - `secondaryDisplayProperties` string[], required: An array of strings representing additional properties used for displaying the object. - `updatedAt` string, date-time: A string in date-time format indicating when the object was last updated. - `updatedByUserId` integer: A string representing the ID of the user who last updated the object. ## Other responses - `default`: An error occurred. --- [API](https://skmtc.dev/hubspot/apis/cms-media-bridge.md) - [All operations](https://skmtc.dev/hubspot/apis/cms-media-bridge/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/cms-media-bridge/revisions/8f11766b98c4?raw)