Skip to main content

Role GET‚Äč

Required Permissions: Role Get or Role Admin

Path Parameters
    roleId integer required

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

Responses

A JSON Object containing a role's data.


Schema
    role object
    id integer
    name string
    description string
    created_at date-time
    created_by_user_id integer
    updated_at date-time nullable
    updated_by_user_id integer nullable
    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 object nullable
    avatar_file_upload_url string
    created_at date-time
    created_by_user_id integer

    Possible values: >= 1

    department string
    email email
Loading...