Role GET

GET 
/roles/:roleId

Required Permissions: Role Get or Role Admin

Request

Path Parameters

roleId integerrequired

The id of the Role that you wish to get data from.

Responses

200

A JSON Object containing a role's data.

application/json

Schema

Schema

role object
id integer
name string
description string
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
deletable boolean
default_user_role boolean
full_admin_role boolean
permissions object[]
Array [
permission_id integer
role_id integer
permission object
id integer
name string
description string
category_id integer
]
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email

Example (from schema)

{
  "role": {
    "id": 0,
    "name": "Admin",
    "description": "A role with all permissions except user CRUD",
    "created_at": "2024-12-02T14:38:57.864Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-02T14:38:57.864Z",
    "updated_by_user_id": 0,
    "deletable": true,
    "default_user_role": false,
    "full_admin_role": false,
    "permissions": [
      {
        "permission_id": 0,
        "role_id": 0,
        "permission": {
          "id": 0,
          "name": "string",
          "description": "string",
          "category_id": 0
        }
      }
    ],
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-02T14:38:57.864Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "user@example.com"
    }
  }
}

Loading...