GET
/
settings
/
v3
/
users
/
Retrieves a list of users from an account
curl --request GET \
  --url https://api.hubapi.com/settings/v3/users/ \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "id": "123",
      "email": "newUser@email.com",
      "roleId": "100",
      "primaryTeamId": "101",
      "secondaryTeamIds": [
        "102"
      ],
      "superAdmin": "false"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

Required Scopes

This API requires one of the following scopes:
  • crm.objects.users.read
  • settings.users.read

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit
integer

The number of users to retrieve

after
string

Results will display maximum 100 users per page. Additional results will be on the next page.

Response

200
application/json

successful operation

The response is of type object.