UPupvest
Roles

Get all roles

Returns a paginated list of roles.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching roles. Use user_id to filter by a specific user, entity_id to filter by account group or business, and sort/order to control the ordering by created_at or updated_at.

See the User roles guide (TOL / BYOL) for role types and assignment rules.

get/roles

Request

  • Base URL
    https://sandbox.upvest.co
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://sandbox.upvest.co/auth/token
    Scopesroles:read, roles:admin

Path parameters

user_idstring uuid required

Unique identifier of the user, as a UUID.

The unique identifier of the user. Universally Unique Identifier (UUID).

Query parameters

sort'created_at' | 'updated_at'

The field to sort the results by. One of created_at or updated_at; defaults to created_at.

user_idstring uuid

Unique identifier of the user, as a UUID.

Filters results by user ID. Universally Unique Identifier (UUID).

entity_idstring uuid

Unique identifier of the entity a role is attached to.

Filters results by entity ID. Universally Unique Identifier (UUID).

order'ASC' | 'DESC'

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

offsetinteger

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

limitinteger

Use the limit argument to specify the maximum number of items returned.

Response

OK

Changes

No recorded changes to this operation across all 34 revisions of this API.