List roles
curl --request POST \
--url 'https://api.flashcat.cloud/role/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"orderby": "created_at",
"asc": false
}
'import requests
url = "https://api.flashcat.cloud/role/list?app_key="
payload = {
"orderby": "created_at",
"asc": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({orderby: 'created_at', asc: false})
};
fetch('https://api.flashcat.cloud/role/list?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/role/list?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderby' => 'created_at',
'asc' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/role/list?app_key="
payload := strings.NewReader("{\n \"orderby\": \"created_at\",\n \"asc\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/role/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"orderby\": \"created_at\",\n \"asc\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/role/list?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderby\": \"created_at\",\n \"asc\": false\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 4,
"items": [
{
"role_id": 150,
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"status": "enabled",
"permission_ids": [
501,
502
],
"editable": true,
"created_at": 1710000000,
"updated_at": 1712000000
},
{
"role_id": 2,
"role_name": "Admin",
"description": "Account Administrator, has all account permissions and can assist the main account in managing all affairs.",
"status": "enabled",
"permission_ids": [
101,
102,
201,
701
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
},
{
"role_id": 6,
"role_name": "Responder",
"description": "Responder, has standard permissions except billing center, member management, role management and single sign-on management, suitable for members handling daily operations.",
"status": "enabled",
"permission_ids": [
201,
701
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
},
{
"role_id": 8,
"role_name": "Viewer",
"description": "Viewer, has most read-only permissions except audit and onboarding, suitable for members who only need to view data.",
"status": "enabled",
"permission_ids": [
103
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Roles & permissions
List roles
Return all custom and built-in roles for the current account.
POST
/
role
/
list
List roles
curl --request POST \
--url 'https://api.flashcat.cloud/role/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"orderby": "created_at",
"asc": false
}
'import requests
url = "https://api.flashcat.cloud/role/list?app_key="
payload = {
"orderby": "created_at",
"asc": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({orderby: 'created_at', asc: false})
};
fetch('https://api.flashcat.cloud/role/list?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/role/list?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderby' => 'created_at',
'asc' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/role/list?app_key="
payload := strings.NewReader("{\n \"orderby\": \"created_at\",\n \"asc\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/role/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"orderby\": \"created_at\",\n \"asc\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/role/list?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderby\": \"created_at\",\n \"asc\": false\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 4,
"items": [
{
"role_id": 150,
"role_name": "On-call Manager",
"description": "Manage on-call rotations and incidents.",
"status": "enabled",
"permission_ids": [
501,
502
],
"editable": true,
"created_at": 1710000000,
"updated_at": 1712000000
},
{
"role_id": 2,
"role_name": "Admin",
"description": "Account Administrator, has all account permissions and can assist the main account in managing all affairs.",
"status": "enabled",
"permission_ids": [
101,
102,
201,
701
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
},
{
"role_id": 6,
"role_name": "Responder",
"description": "Responder, has standard permissions except billing center, member management, role management and single sign-on management, suitable for members handling daily operations.",
"status": "enabled",
"permission_ids": [
201,
701
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
},
{
"role_id": 8,
"role_name": "Viewer",
"description": "Viewer, has most read-only permissions except audit and onboarding, suitable for members who only need to view data.",
"status": "enabled",
"permission_ids": [
103
],
"editable": false,
"created_at": 1653530940,
"updated_at": 1653530940
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
- Custom roles (enabled and disabled) come first, sorted by
orderby/asc; the three built-in roles —2Admin,6Responder,8Viewer — are appended at the end unlessno_globalis true, and are counted intotal. - Built-in roles have
editable: false, and theirdescriptionfollows the request language (Accept-Languageheader, or thelocale/langquery parameter).
Authorizations
Body
application/json
Filters for listing roles.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?