Roles LIST

GET 
https://sandbox.absmartly.com/v1/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

200

A JSON Object containing an array of all roles.

application/json

Schema

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
]

Example (from schema)

{
  "items": 0,
  "page": 0,
  "total": 0,
  "roles": [
    {
      "id": 0,
      "name": "Admin",
      "description": "A role with all permissions except user CRUD",
      "created_at": "2025-07-07T10:04:10.751Z",
      "created_by_user_id": 0,
      "updated_at": "2025-07-07T10:04:10.751Z",
      "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": "2025-07-07T10:04:10.751Z",
        "created_by_user_id": 0,
        "department": "Marketing",
        "email": "[email protected]"
      }
    }
  ]
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: A User API Key for API authorization. **Must be in the format "Api-Key your_user_api_key"**scheme: ^Api-Key\s\S+

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://sandbox.absmartly.com/v1/roles' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://sandbox.absmartly.com/v1

Auth

UserApiKey

Parameters

sort — query

sort_asc — query

---truefalse

page — query

items — query

ResponseClear

Click the Send API Request button above and see the response here!