---
title: "Retrieves the roles on an account"
method: GET
path: "/settings/v3/users/roles"
tags: ["Roles"]
---

# Retrieves the roles on an account

`GET /settings/v3/users/roles`

Retrieves the roles on an account

## Response `200`

successful operation

- CollectionResponsePublicPermissionSetNoPaging
  - `results` PublicPermissionSet[], required
    - `id` string, required — The role's unique ID
    - `name` string, required — The role's name
    - `requiresBillingWrite` boolean, required — Whether this role has a paid seat and requires the billing-write scope to assign/unassign to users

## Other responses

- `default` — An error occurred.

## Changes

- **2026-08-17** (v3) `b5b726b64126` — 2 info
  - the security scope `settings.users.read` was added to the endpoint's security scheme `oauth2`
  - the security scope `crm.objects.users.read` was removed from the endpoint's security scheme `oauth2`
- **2026-07-13** (v3) `0cf03274b2c8` — 1 info
  - endpoint added
- **2026-07-13** (v3) `88afd8abb54e` — 1 breaking
  - api path removed without deprecation
- **2026-06-15** (v3) `0cf03274b2c8` — 1 breaking, 5 info
  - the `results/items/` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - the security scope `settings.users.read` was added to the endpoint's security scheme `oauth2`
  - the security scope `crm.objects.users.read` was removed from the endpoint's security scheme `oauth2`
  - added the required property `results/items/id` to the response with the `200` status
  - …2 more
- **2026-06-15** (v3) `7742dcf4e0c9` — 4 breaking, 2 info
  - the `results/items/` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the required property `results/items/id` from the response with the `200` status
  - removed the required property `results/items/name` from the response with the `200` status
  - removed the required property `results/items/requiresBillingWrite` from the response with the `200` status
  - …2 more

[Full history](https://skmtc.dev/hubspot/apis/settings-user-provisioning/changes/settings/v3/users/roles/get.md)

---

[API](https://skmtc.dev/hubspot/apis/settings-user-provisioning.md) · [All operations](https://skmtc.dev/hubspot/apis/settings-user-provisioning/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hubspot/settings-user-provisioning/revisions/b5b726b64126/schema)