HubSpot: Owners schemas
5 HubSpot schemas with complete fields and constraints.
← Owners operations · All schemas
List owners — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paging | Model | Optional | Expand List owners — response body — paging |
results | array | Required within parent | An array of PublicOwner objects, each representing an individual owner with their specific details. |
results[] | Model | Each item | Expand Retrieve a specific owner by ID — response body |
Referenced models: List owners — response body — paging, Retrieve a specific owner by ID — response body
List owners — response body — paging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page. |
next | Model | Optional | Expand List owners — response body — paging next |
Referenced models: List owners — response body — paging next
List owners — response body — paging next
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the paging information needed to retrieve the next set of results in a paginated API response |
after | string | Required within parent | A string token used as a cursor for pagination, indicating the position after the last item on the current page. |
link | string | Optional | A string containing the URL link to the next page of results. |
Retrieve a specific owner by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived | boolean | Required within parent | Indicates whether the owner is archived. |
createdAt | string | Required within parent | The date and time when the owner was created. Format: date-time |
email | string | Optional | The email address of the owner. |
firstName | string | Optional | The first name of the owner. |
id | string | Required within parent | The unique identifier of the owner. |
lastName | string | Optional | The last name of the owner. |
teams | array | Optional | An array of teams associated with the owner, where each team is represented by a PublicTeam object. |
teams[] | Model | Each item | Expand Retrieve a specific owner by ID — response body — teams item |
type | string | Required within parent | The type of the owner, which can be either PERSON or QUEUE. Known values: PERSON, QUEUE |
updatedAt | string | Required within parent | The date and time when the owner was last updated. Format: date-time |
userId | JSON | Optional | |
userId (anyOf 1) | integer | Alternative | The user ID of the owner. Format: int32 |
userId (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
userIdIncludingInactive | JSON | Optional | |
userIdIncludingInactive (anyOf 1) | integer | Alternative | The user ID of the owner, including inactive users. Format: int32 |
userIdIncludingInactive (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve a specific owner by ID — response body — teams item
Retrieve a specific owner by ID — response body — teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier for the team, represented as a string. |
name | string | Required within parent | The name of the team, represented as a string. |
primary | boolean | Required within parent | A boolean indicating whether this team is the primary team. |