Skip to main content

Roles LIST

GET 

/roles

Required Permissions: Role List or Role Admin

Request

Query Parameters

    sort string

    The object key to sort the results by.

    sort_asc boolean
    page integer
    items integer

Responses

A JSON Object containing an array of all roles.

Schema
    items integer
    page integer

    Possible values: >= 1

    total integer
    roles object[]
  • Array [
  • 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
  • ]
Loading...