HubSpot: User provisioning schemas

← User provisioning operations · All schemas

Create a user — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user being provisioned. This is a required field and must be unique.
firstName	string	Optional	The first name of the user.
lastName	string	Optional	The last name of the user.
primaryTeamId	string	Optional	The identifier for the primary team to which the user belongs.
roleId	string	Optional	The identifier for the role assigned to the user.
seatNames	array	Optional	An array of seat names assigned to the user, representing different permissions or access levels.
seatNames[]	string	Each item
secondaryTeamIds	array	Optional	An array of identifiers for secondary teams to which the user is associated.
secondaryTeamIds[]	string	Each item
sendWelcomeEmail	boolean	Required within parent	A boolean indicating whether a welcome email should be sent to the user upon provisioning. This is a required field.

Create a user — response body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user. This is a required field and must be unique.
firstName	string	Optional	The first name of the user, represented as a string.
id	string	Required within parent	The unique identifier for the user, represented as a string.
lastName	string	Optional	The last name of the user, represented as a string.
primaryTeamId	string	Optional	The ID of the primary team to which the user belongs, represented as a string.
roleId	string	Optional	A string representing a single role ID assigned to the user.
roleIds	array	Required within parent	An array of strings representing the IDs of the roles assigned to the user. This is a required field.
roleIds[]	string	Each item
seatNames	array	Optional	An array of strings representing the names of seats assigned to the user.
seatNames[]	string	Each item
secondaryTeamIds	array	Optional	An array of strings representing the IDs of secondary teams to which the user is associated.
secondaryTeamIds[]	string	Each item
sendWelcomeEmail	boolean	Optional	A boolean indicating whether a welcome email should be sent to the user.
superAdmin	boolean	Required within parent	A boolean indicating whether the user has super admin privileges. This is a required field.

Modifies a user — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
firstName	string	Optional	The first name of the user. It is a string value.
lastName	string	Optional	The last name of the user. It is a string value.
primaryTeamId	string	Optional	The identifier for the user's primary team. It is a string value.
roleId	string	Optional	The identifier for the user's role. It is a string value.
seatNames	array	Optional	An array of seat names associated with the user. Each item in the array is a string.
seatNames[]	string	Each item
secondaryTeamIds	array	Optional	An array of identifiers for the user's secondary teams. Each item in the array is a string.
secondaryTeamIds[]	string	Each item

Retrieves the roles on an account — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of PublicPermissionSet objects, each representing a specific permission set. This property is required.
results[]	Model	Each item	Expand Retrieves the roles on an account — response body — results item

Referenced models: Retrieves the roles on an account — response body — results item

Retrieves the roles on an account — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the permission set. It is a string.
name	string	Required within parent	The name of the permission set. It is a string.
requiresBillingWrite	boolean	Required within parent	A boolean indicating whether the permission set requires billing write access.

Retrieves the seats on this account — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of PublicSeat objects, each representing a seat with its associated properties.
results[]	Model	Each item	Expand Retrieves the seats on this account — response body — results item

Referenced models: Retrieves the seats on this account — response body — results item

Retrieves the seats on this account — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A string providing additional details about the seat.
name	string	Required within parent	The name of the seat. This is a required string property.
remainingSeats	JSON	Optional
remainingSeats (anyOf 1)	integer	Alternative	An integer indicating the number of seats that are still available. Format: int32
remainingSeats (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieves users — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieves users — response body — paging
results	array	Required within parent	An array of PublicUser objects representing the users returned in the current page.
results[]	Model	Each item	Expand Create a user — response body

Referenced models: Create a user — response body, Retrieves users — response body — paging

Retrieves users — 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 Retrieves users — response body — paging next

Referenced models: Retrieves users — response body — paging next

Retrieves users — 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 that indicates the position after the last item in the current page. It is used as a cursor to fetch the next set of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

See details about this account's teams — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of PublicTeam objects, each representing a team with its associated properties.
results[]	Model	Each item	Expand See details about this account's teams — response body — results item

Referenced models: See details about this account's teams — response body — results item

See details about this account's teams — response body — results 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.
secondaryUserIds	array	Required within parent	An array of strings representing the IDs of users who are secondary members of the team.
secondaryUserIds[]	string	Each item
userIds	array	Required within parent	An array of strings representing the IDs of users who are primary members of the team.
userIds[]	string	Each item