Skip to main content
GET
/
v1
/
users
/
roles
/
{id}
Get user role
curl --request GET \
  --url https://api.hyperline.co/v1/users/roles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "rol_DKL4Xcb5VSa8CQ",
  "name": "Admin",
  "description": null,
  "is_default": false
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

​
id
string
required

Role ID.

Example:

"rol_DKL4Xcb5VSa8CQ"

​
name
string
required

Role name.

Example:

"Admin"

​
description
string | null
required

Role description.

Example:

null

​
is_default
boolean
required

Whether this is the default role assigned to new users.

Example:

false