Retrieves the roles on an account

curl --request GET \
  --url https://api.hubapi.com/settings/v3/users/roles \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "id": "100",
      "name": "Test Role",
      "requiresBillingWrite": "False"
    }
  ]
}

GET

settings

users

roles

Retrieves the roles on an account

curl --request GET \
  --url https://api.hubapi.com/settings/v3/users/roles \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "id": "100",
      "name": "Test Role",
      "requiresBillingWrite": "False"
    }
  ]
}

Supported products

Requires one of the following products or higher.

Marketing HubFree

Sales HubFree

Service HubFree

Content HubFree

Required Scopes

This API requires one of the following scopes:

Authorization

string

header

required

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

200

application/json

successful operation

The response is of type object.