HubSpot: Limits tracking schemas
16 HubSpot schemas with complete fields and constraints.
← Limits tracking operations · All schemas
Read association label limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
results | array | Required within parent | An array of AssociationLabelLimitResponse objects, each detailing the limits and usage of association labels between object types. |
results[] | Model | Each item | Expand Read association label limits — response body — results item |
Referenced models: Read association label limits — response body — results item
Read association label limits — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allLabels | array | Required within parent | A list of all association labels. |
allLabels[] | string | Each item | |
fromObjectType | Model | Required within parent | Expand Read association label limits — response body — results item to Object Type |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | The maximum number of association labels allowed. Format: int64 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percentage | JSON | Required within parent | |
percentage (anyOf 1) | number | Alternative | The percentage of the association label limit that has been used. |
percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
toObjectType | Model | Required within parent | Expand Read association label limits — response body — results item to Object Type |
usage | JSON | Required within parent | |
usage (anyOf 1) | integer | Alternative | The current number of association labels used. Format: int64 |
usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Read association label limits — response body — results item to Object Type
Read association label limits — response body — results item to Object Type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
objectTypeId | string | Required within parent | The unique identifier for the object type. |
pluralLabel | string | Required within parent | The plural form label for the object type. |
singularLabel | string | Required within parent | The singular form label for the object type. |
Read calculation property limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
byObjectType | array | Required within parent | An array detailing the usage of calculated properties by object type, with each entry providing specific usage information for an object type. |
byObjectType[] | Model | Each item | Expand Read calculation property limits — response body — by Object Type item |
overallLimit | JSON | Required within parent | |
overallLimit (anyOf 1) | integer | Alternative | The maximum number of calculated properties allowed. Format: int64 |
overallLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallPercentage | JSON | Required within parent | |
overallPercentage (anyOf 1) | number | Alternative | The percentage of the overall limit that is currently being used for calculated properties. |
overallPercentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallUsage | JSON | Required within parent | |
overallUsage (anyOf 1) | integer | Alternative | The total number of calculated properties currently in use. Format: int64 |
overallUsage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Read calculation property limits — response body — by Object Type item
Read calculation property limits — response body — by Object Type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
objectTypeId | string | Required within parent | The unique identifier for the object type. |
pluralLabel | string | Required within parent | The plural form of the label for the object type. |
singularLabel | string | Required within parent | The singular form of the label for the object type. |
usage | JSON | Required within parent | |
usage (anyOf 1) | integer | Alternative | The number of records used for the object type. Format: int64 |
usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Read custom object limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | The maximum number of custom objects allowed. Format: int64 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percentage | JSON | Required within parent | |
percentage (anyOf 1) | number | Alternative | The percentage of the custom object limit that is currently used. |
percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
usage | JSON | Required within parent | |
usage (anyOf 1) | integer | Alternative | The current number of custom objects used. Format: int64 |
usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Read custom property limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
byObjectType | array | Required within parent | An array detailing the limit and usage of custom properties for each specific object type. |
byObjectType[] | Model | Each item | Expand Read custom property limits — response body — by Object Type item |
overallLimit | JSON | Required within parent | |
overallLimit (anyOf 1) | integer | Alternative | The total limit for custom properties across all objects. Format: int64 |
overallLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallPercentage | JSON | Required within parent | |
overallPercentage (anyOf 1) | number | Alternative | The percentage of the overall custom property limit that has been used. |
overallPercentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallUsage | JSON | Required within parent | |
overallUsage (anyOf 1) | integer | Alternative | The total number of custom properties currently in use across all objects. Format: int64 |
overallUsage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Read custom property limits — response body — by Object Type item
Read custom property limits — response body — by Object Type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | The maximum allowed count for the object type. Format: int64 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
objectTypeId | string | Required within parent | The unique identifier for the object type. |
percentage | JSON | Required within parent | |
percentage (anyOf 1) | number | Alternative | The percentage of the limit that has been used. |
percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
pluralLabel | string | Required within parent | The plural label for the object type. |
singularLabel | string | Required within parent | The singular label for the object type. |
usage | JSON | Required within parent | |
usage (anyOf 1) | integer | Alternative | The current usage count for the object type. Format: int64 |
usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Read pipeline limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customObjectTypes | Model | Required within parent | Expand Read record limits — response body — custom Object Types |
hubspotDefinedObjectTypes | array | Required within parent | An array of objects representing the limits and usage for HubSpot-defined object types. Each object includes details such as the object type ID, singular and plural labels, limit, usage, and percentage of usage. |
hubspotDefinedObjectTypes[] | Model | Each item | Expand Read custom property limits — response body — by Object Type item |
Referenced models: Read record limits — response body — custom Object Types, Read custom property limits — response body — by Object Type item
Read record association limits between two objects — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
atLimitFromRecordSamples | array | Required within parent | An array of AtLimitRecordSample objects, each representing a sample record that is at the association limit. |
atLimitFromRecordSamples[] | Model | Each item | Expand Read record association limits between two objects — response body — at Limit From Record Samples item |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | The maximum number of associations allowed for records. Format: int64 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
nearLimitFromRecordSamples | array | Required within parent | An array of NearLimitRecordSample objects, each representing a sample record that is near the association limit. |
nearLimitFromRecordSamples[] | Model | Each item | Expand Read record association limits between two objects — response body — near Limit From Record Samples item |
totalRecordsAtLimit | JSON | Required within parent | |
totalRecordsAtLimit (anyOf 1) | integer | Alternative | The total number of records that have reached their association limit. Format: int32 |
totalRecordsAtLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalRecordsNearLimit | JSON | Required within parent | |
totalRecordsNearLimit (anyOf 1) | integer | Alternative | The total number of records that are approaching their association limit. Format: int32 |
totalRecordsNearLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Read record association limits between two objects — response body — at Limit From Record Samples item, Read record association limits between two objects — response body — near Limit From Record Samples item
Read record association limits between two objects — response body — at Limit From Record Samples item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Required within parent | The label associated with a record that is at its limit. |
objectId | JSON | Required within parent | |
objectId (anyOf 1) | integer | Alternative | The objectId of the object that is at its limit. Format: int64 |
objectId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Read record association limits between two objects — response body — near Limit From Record Samples item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Required within parent | The primary identifier of the record. |
objectId | JSON | Required within parent | |
objectId (anyOf 1) | integer | Alternative | The unique identifier for the object. Format: int64 |
objectId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
percentage | JSON | Required within parent | |
percentage (anyOf 1) | number | Alternative | The percentage of the limit that has been used. |
percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
usage | JSON | Required within parent | |
usage (anyOf 1) | integer | Alternative | The number of records currently in use. Format: int64 |
usage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Read record association limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
results | array | Required within parent | An array containing details of object types that are near or at their association limits. Each item in the array is an ObjectTypeNearOrAtAssociationLimit object. |
results[] | Model | Each item | Expand Read record association limits — response body — results item |
Referenced models: Read record association limits — response body — results item
Read record association limits — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hasRecordsAtLimit | boolean | Required within parent | Indicates whether there are records that have reached the association limit. |
hasRecordsNearLimit | boolean | Required within parent | Indicates whether there are records that are approaching the association limit. |
objectTypeId | string | Required within parent | The unique identifier for the object type. |
pluralLabel | string | Required within parent | The plural form of the label for the object type. |
singularLabel | string | Required within parent | The singular form of the label for the object type. |
Read record limits — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customObjectTypes | Model | Required within parent | Expand Read record limits — response body — custom Object Types |
hubspotDefinedObjectTypes | array | Required within parent | An array of objects detailing the limits and usage for HubSpot-defined object types. |
hubspotDefinedObjectTypes[] | Model | Each item | Expand Read custom property limits — response body — by Object Type item |
Referenced models: Read record limits — response body — custom Object Types, Read custom property limits — response body — by Object Type item
Read record limits — response body — custom Object Types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
byObjectType | array | Required within parent | An array containing usage details for each object type, with each entry providing specific usage information for a particular object type. |
byObjectType[] | Model | Each item | Expand Read calculation property limits — response body — by Object Type item |
overallLimit | JSON | Required within parent | |
overallLimit (anyOf 1) | integer | Alternative | The maximum number of custom object records allowed. Format: int64 |
overallLimit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallPercentage | JSON | Required within parent | |
overallPercentage (anyOf 1) | number | Alternative | The percentage of the overall custom object record limit that has been used. |
overallPercentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
overallUsage | JSON | Required within parent | |
overallUsage (anyOf 1) | integer | Alternative | The total number of custom object records currently in use. Format: int64 |
overallUsage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Read calculation property limits — response body — by Object Type item