Retrieve role
GETapi.blutui.com/v1/agencies/{username}/roles/{id}
Retrieve a role in your agency.
Response
import Blutui from 'blutui'
const blutui = new Blutui('ey....')
blutui.agency('studio').roles.get(2){
"id": 2,
"object": "role",
"name": "Developer",
"description": null,
"is_super": false,
"permissions": {
"user.read": false,
"user.invite": false,
"user.delete": false,
"user.admin": false,
"organization.read": false,
"organization.write": false,
"organization.delete": false,
"site.read": false,
"site.write": false,
"site.delete": false,
"site.publish": false,
"site.transfer": false,
"site.export": false,
"domain.read": false,
"domain.write": false,
"domain.delete": false,
"stripe": false,
"cli": false
},
"created_at": 1711305486,
"updated_at": 1711305486
}idstring
The unique identifier for this role.
objectstring
This will always contain role for this endpoint.
namestring
The role name.
descriptionstring | null
The description of the role.
is_superboolean
Determine if the role is a super role. Super roles cannot be removed.
permissionsobject
An object defining the permissions associated with the role. Each key in the object represents a specific permission, and the value is a boolean indicating whether the permission is granted (true) or denied (false).
created_attimestamp
The role's created at timestamp.
updated_attimestamp
The role's updated at timestamp.
Last updated on