List properties
Retrieve a list of properties for a specified object type in your HubSpot account. This endpoint allows you to filter results based on archived status and control pagination through query parameters. It is useful for obtaining metadata about object properties, such as their labels, types, and other attributes.
Supported products
Supported products
Scope requirements
Scope requirements
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the object type whose properties are being retrieved.
Query Parameters
A paging cursor token for pagination. Use the value from the previous response's paging.next.after field to retrieve the next set of results.
Whether to return only results that have been archived. Defaults to false.
A list of specific fields to include in the response. Possible values include category, label, type, fieldType, and more.
category, label, type, fieldType, groupName, description, options, createdAt, updatedAt, hidden, readOnlyValue, readOnlyDefinition, hasUniqueValue, archivable, readOnlyOptions, calculationFormula, archived, calculated, optionsSource, dateDisplayFormat, numberDisplayFormat, currencyPropertyName, updatedByUserId, createdByUserId, dataEntryInstructions, optionColors, accessAllowlist, dataSensitivity, defaultValue, formField, sensitiveDataCategories, validationRules, rollupConfig, syncConfig The maximum number of results to display per page. Defaults to 25.