Skip to main content
GET
/
api
/
v3
/
roles
Get roles (pagination support)
curl --request GET \
  --url https://apix.us.amity.co/api/v3/roles \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "data": [
    {
      "roleId": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "permissions": [
        "<string>"
      ],
      "isDeleted": false,
      "displayName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
keyword
string
required

search keyword

Maximum string length: 100
​
sortBy
enum<string>
default:lastCreated
Available options:
lastCreated,
firstCreated,
displayName
​
options
object

Response

Role Information

​
status
string
​
data
object[]