List all user roles

Returns a list of all user roles in an organization.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

To use this endpoint, select Read Users under the Setup & Administration category when creating or editing an API token. Learn More.

GET /user-roles

List all user roles

cURL

curl --request GET \
  --url https://api.samsara.com/user-roles \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "8a9371af-82d1-4158-bf91-4ecc8d3a114c",
      "name": "Full Admin"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer<int64>

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

Required range: 1 <= x <= 512

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

200

application/json

List all user roles.

A list of user roles.

data · object[]

A list of user roles

Show child attributes

pagination · object

Pagination parameters.

Show child attributes