User details
Use this API to fetch information about users in the account, along with updating their working hours, timezone, additional phone number, and job title properties.
Sync HubSpot user working hours with an external workforce management tool.
post
/crm/v3/objects/users/batch/read
Requirements
Parameters
Request
xxxxxxxxxx
18
curl --request POST \
--url 'https://api.hubapi.com/crm/v3/objects/users/batch/read?archived=false' \
--header 'authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--data '{
"propertiesWithHistory": [
"string"
],
"idProperty": "string",
"inputs": [
{
"id": "string"
}
],
"properties": [
"string"
]
}'
get
/crm/v3/objects/users
Read a page of users. Control what is returned via the properties
query param.
Requirements
Parameters
get
/crm/v3/objects/users/{userId}
Read an Object identified by {userId}
. {userId}
refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty
query param. Control what is returned via the properties
query param.
Requirements
Parameters
post
/crm/v3/objects/users/search
Requirements
crm.objects.users.read
Exempt from the per-ten-second API call limit
Parameters
Request
xxxxxxxxxx
30
curl --request POST \
--url https://api.hubapi.com/crm/v3/objects/users/search \
--header 'authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--data '{
"query": "string",
"limit": 0,
"after": "string",
"sorts": [
"string"
],
"properties": [
"string"
],
"filterGroups": [
{
"filters": [
{
"highValue": "string",
"propertyName": "string",
"values": [
"string"