curl --request GET \
--url http://{defaultHost}/api/v2/platform/roles \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "role",
"attributes": {
"name": "Role 1",
"created_at": "2022-11-08T19:35:06.596Z",
"updated_at": "2022-11-08T19:35:06.596Z"
}
},
{
"id": "2",
"type": "role",
"attributes": {
"name": "Role 2",
"created_at": "2022-11-08T19:35:06.597Z",
"updated_at": "2022-11-08T19:35:06.597Z"
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/roles?page=1&per_page=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page="
}
}
Returns a list of Roles
curl --request GET \
--url http://{defaultHost}/api/v2/platform/roles \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "1",
"type": "role",
"attributes": {
"name": "Role 1",
"created_at": "2022-11-08T19:35:06.596Z",
"updated_at": "2022-11-08T19:35:06.596Z"
}
},
{
"id": "2",
"type": "role",
"attributes": {
"name": "Role 2",
"created_at": "2022-11-08T19:35:06.597Z",
"updated_at": "2022-11-08T19:35:06.597Z"
}
}
],
"meta": {
"count": 2,
"total_count": 2,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/roles?page=1&per_page=&filter[name_eq]=",
"next": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/roles?filter%5Bname_eq%5D=&page=1&per_page="
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Records returned
The response is of type object
.
Was this page helpful?