> ## 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: 18093c5b-5723-4f5e-864f-9de0edf3fbd1
---

# Retrieve all custom object schemas.

> Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => {
  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"
    },
    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://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="ENTERPRISE" salesLevel="ENTERPRISE" serviceLevel="ENTERPRISE" cmsLevel="ENTERPRISE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'crm.schemas.custom.read',
  'crm.objects.custom.sensitive.read.v2',
  'crm.objects.custom.highly_sensitive.read.v2',
  'crm.objects.custom.read'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/legacy/v3/crm-schemas-v3.json GET /crm-object-schemas/v3/schemas
openapi: 3.0.1
info:
  title: Schemas
  description: >-
    The CRM uses schemas to define how custom objects should store and represent
    information in the HubSpot CRM. Schemas define details about an object's
    type, properties, and associations. The schema can be uniquely identified by
    its **object type ID**.
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: ENTERPRISE
    sales: ENTERPRISE
    service: ENTERPRISE
    cms: ENTERPRISE
    commerce: ENTERPRISE
    crmHub: ENTERPRISE
    dataHub: ENTERPRISE
  x-hubspot-api-use-case: >-
    Create a new object for storing information about cars at a car dealership.
    Your object definition could include properties to store information as well
    as the filters available on the custom object index page.
  x-hubspot-related-documentation:
    - name: Custom Object Guide
      url: >-
        https://developers.hubspot.com/docs/guides/api/crm/objects/custom-objects
  x-hubspot-introduction: >-
    Use the custom objects schema API to define new types of CRM records in your
    account. After setting up an object schema, you'll then be able to create
    records for that custom object both in HubSpot and using the objects API.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /crm-object-schemas/v3/schemas:
    get:
      tags:
        - Basic
      summary: Retrieve all custom object schemas.
      description: >-
        Retrieve all custom object schemas, with options to include property
        definitions, association definitions, and audit metadata.
      operationId: get-/crm-object-schemas/v3/schemas_getAll
      parameters:
        - 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
        - name: includeAssociationDefinitions
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
        - name: includeAuditMetadata
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
        - name: includePropertyDefinitions
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseObjectSchemaNoPaging'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.schemas.custom.read
        - oauth2:
            - crm.objects.custom.sensitive.read.v2
        - oauth2:
            - crm.objects.custom.highly_sensitive.read.v2
        - oauth2:
            - crm.objects.custom.read
components:
  schemas:
    CollectionResponseObjectSchemaNoPaging:
      required:
        - results
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ObjectSchema'
    ObjectSchema:
      required:
        - associations
        - id
        - labels
        - name
        - properties
        - requiredProperties
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
        archived:
          type: boolean
        associations:
          type: array
          description: Associations defined for a given object type.
          items:
            $ref: '#/components/schemas/AssociationDefinition'
        createdAt:
          type: string
          description: When the object schema was created.
          format: date-time
        createdByUserId:
          type: integer
          format: int32
        description:
          type: string
        fullyQualifiedName:
          type: string
          description: >-
            An assigned unique ID for the object, including portal ID and object
            name.
        id:
          type: string
          description: >-
            A unique ID for this schema's object type. Will be defined as
            {meta-type}-{unique ID}.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        name:
          type: string
          description: A unique name for the schema's object type.
        objectTypeId:
          type: string
        primaryDisplayProperty:
          type: string
          description: >-
            The name of the primary property for this object. This will be
            displayed as primary on the HubSpot record page for this object
            type.
        properties:
          type: array
          description: Properties defined for this object type.
          items:
            $ref: '#/components/schemas/Property'
        requiredProperties:
          type: array
          description: >-
            The names of properties that should be **required** when creating an
            object of this type.
          items:
            type: string
        searchableProperties:
          type: array
          description: >-
            Names of properties that will be indexed for this object type in by
            HubSpot's product search.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            The names of secondary properties for this object. These will be
            displayed as secondary on the HubSpot record page for this object
            type.
          items:
            type: string
        updatedAt:
          type: string
          description: When the object schema was last updated.
          format: date-time
        updatedByUserId:
          type: integer
          format: int32
      description: Defines an object schema, including its properties and associations.
      example:
        associations:
          - fromObjectTypeId: 2-123456
            id: '123'
            name: my_object_to_contact
            toObjectTypeId: 0-1
        createdAt: '2020-02-20T18:07:11.390Z'
        fullyQualifiedName: p7878787_my_object"
        id: '123456'
        labels:
          plural: My objects
          singular: My object
        metaType: PORTAL_SPECIFIC
        name: my_object
        primaryDisplayProperty: my_object_property
        properties:
          - archived: false
            calculated: false
            createdAt: '2020-02-20T18:07:11.802Z'
            displayOrder: -1
            externalOptions: false
            fieldType: text
            groupName: my_object_information
            hasUniqueValue: false
            label: My object property
            name: my_object_property
            type: string
            updatedAt: '2020-02-20T18:07:11.802Z'
        requiredProperties:
          - my_object_property
        searchableProperties:
          - my_object_property
        updatedAt: '2020-02-20T18:09:07.555Z'
    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
      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: When the association was defined.
          format: date-time
        fromObjectTypeId:
          type: string
          description: ID of the primary object type to link from.
        id:
          type: string
          description: A unique ID for this association.
        name:
          type: string
          description: A unique name for this association.
        toObjectTypeId:
          type: string
          description: ID of the target object type ID to link to.
        updatedAt:
          type: string
          description: When the association was last updated.
          format: date-time
      description: The definition of an association
      example:
        fromObjectTypeId: 2-123456
        id: '105'
        name: my_object_to_contact
        toObjectTypeId: 0-1
    ObjectTypeDefinitionLabels:
      type: object
      properties:
        plural:
          type: string
          description: >-
            The word for multiple objects. (There’s no way to change this
            later.)
        singular:
          type: string
          description: The word for one object. (There’s no way to change this later.)
      description: Singular and plural labels for the object. Used in CRM display.
      example:
        plural: My objects
        singular: My object
    Property:
      required:
        - description
        - fieldType
        - groupName
        - label
        - name
        - options
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Whether or not the property is archived.
        archivedAt:
          type: string
          description: When the property was archived.
          format: date-time
        calculated:
          type: boolean
          description: >-
            For default properties, true indicates that the property is
            calculated by a HubSpot process. It has no effect for custom
            properties.
        calculationFormula:
          type: string
          description: The formula used for calculated properties.
        createdAt:
          type: string
          description: When the property was created
          format: date-time
        createdUserId:
          type: string
          description: >-
            The internal ID of the user who created the property in HubSpot.
            This field may not exist if the property was created outside of
            HubSpot.
        currencyPropertyName:
          type: string
          description: The name of the related currency property.
        dataSensitivity:
          type: string
          description: >-
            Indicates the sensitivity level of the property, such as
            "non_sensitive", "sensitive", or "highly_sensitive".
          enum:
            - highly_sensitive
            - non_sensitive
            - sensitive
        dateDisplayHint:
          type: string
          description: >-
            Controls how date properties are displayed in the HubSpot UI, with
            options such as 'absolute', 'absolute_with_relative', 'time_since',
            and 'time_until'.
          enum:
            - absolute
            - absolute_with_relative
            - time_since
            - time_until
        description:
          type: string
          description: >-
            A description of the property that will be shown as help text in
            HubSpot.
        displayOrder:
          type: integer
          description: >-
            The order that this property should be displayed in the HubSpot UI
            relative to other properties for this object type. Properties are
            displayed in order starting with the lowest positive integer value.
            A value of -1 will cause the property to be displayed **after** any
            positive values.
          format: int32
        externalOptions:
          type: boolean
          description: >-
            For default properties, true indicates that the options are stored
            externally to the property settings.
        fieldType:
          type: string
          description: Controls how the property appears in HubSpot.
        formField:
          type: boolean
          description: Whether or not the property can be used in a HubSpot form.
        groupName:
          type: string
          description: The name of the property group the property belongs to.
        hasUniqueValue:
          type: boolean
          description: >-
            Whether or not the property's value must be unique. Once set, this
            can't be changed.
        hidden:
          type: boolean
          description: Hidden options won't be shown in HubSpot.
          example: false
        hubspotDefined:
          type: boolean
          description: This will be true for default object properties built into HubSpot.
        label:
          type: string
          description: A human-readable property label that will be shown in HubSpot.
        modificationMetadata:
          $ref: '#/components/schemas/PropertyModificationMetadata'
        name:
          type: string
          description: >-
            The internal property name, which must be used when referencing the
            property via the API.
        numberDisplayHint:
          type: string
          description: >-
            Hint for how a number property is displayed and validated in
            HubSpot's UI. Can be: "unformatted", "formatted", "currency",
            "percentage", "duration", or "probability".
          enum:
            - currency
            - duration
            - formatted
            - percentage
            - probability
            - unformatted
        options:
          type: array
          description: >-
            A list of valid options for the property. This field is required for
            enumerated properties, but will be empty for other property types.
          items:
            $ref: '#/components/schemas/Option'
        referencedObjectType:
          type: string
          description: >-
            If this property is related to other object(s), they'll be listed
            here.
        sensitiveDataCategories:
          type: array
          description: >-
            When sensitiveData is true, lists the type of sensitive data
            contained in the property (e.g., "HIPAA").
          items:
            type: string
        showCurrencySymbol:
          type: boolean
          description: >-
            Whether the property will display the currency symbol set in the
            account settings.
        textDisplayHint:
          type: string
          description: >-
            Hint for how the text is displayed and validated in HubSpot's UI.
            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 property data type.
        updatedAt:
          type: string
          description: When the object type was last updated.
          format: date-time
        updatedUserId:
          type: string
          description: >-
            The internal user ID of the user who updated the property in
            HubSpot. This field may not exist if the property was updated
            outside of HubSpot.
      description: A HubSpot property
      example:
        displayOrder: 2
        fieldType: select
        groupName: my_object_information
        hasUniqueValue: false
        label: My object property
        modificationMetadata:
          archivable: true
          readOnlyDefinition: false
          readOnlyOptions: false
          readOnlyValue: false
        name: my_object_property
        options:
          - description: Choice number one
            displayOrder: 1
            hidden: false
            label: Option A
            value: A
          - description: Choice number two
            displayOrder: 2
            hidden: false
            label: Option B
            value: B
        type: enumeration
    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
    PropertyModificationMetadata:
      required:
        - archivable
        - readOnlyDefinition
        - readOnlyValue
      type: object
      properties:
        archivable:
          type: boolean
          description: Indicates whether the property can be archived.
        readOnlyDefinition:
          type: boolean
          description: Indicates whether the property's definition is read-only.
        readOnlyOptions:
          type: boolean
          description: Indicates whether the property's options are read-only.
        readOnlyValue:
          type: boolean
          description: Indicates whether the property's value is read-only.
    Option:
      required:
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: A description of the option.
        displayOrder:
          type: integer
          description: >-
            Options are displayed in order starting with the lowest positive
            integer value. Values of -1 will cause the option to be displayed
            after any positive values.
          format: int32
        hidden:
          type: boolean
          description: Hidden options will not be displayed in HubSpot.
        label:
          type: string
          description: A human-readable option label that will be shown in HubSpot.
        value:
          type: string
          description: >-
            The internal value of the option, which must be used when setting
            the property value through the API.
      description: A HubSpot property option
      example:
        description: Choice number one
        displayOrder: 1
        hidden: false
        label: Option A
        value: A
  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:
            crm.objects.custom.highly_sensitive.read.v2: ''
            crm.objects.custom.read: ''
            crm.objects.custom.sensitive.read.v2: ''
            crm.schemas.custom.read: ''
            crm.schemas.custom.write: ''
            oauth: ''

````