Get admin roles

Get admin roles available to the provider using GET.

Use these role IDs when creating admin users.

Request

For every API request you make, you'll need to present the API access key in the HTTP Header as X-API-Key to be authenticated.

Example code in PHP

$request_url = 'https://api.frontcore.com/v2/admin-roles';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  'X-API-Key: {your-api-key}',
  'Accept: application/json',
));
$result = curl_exec($ch);
curl_close($ch);
               

Response

If the method is successful it responds with an JSON structure, as it is shown below.

[
    {
        "id": 1,
        "title": "Administrator",
        "description": "Full provider administration access"
    },
    {
        "id": 703,
        "title": "Sales person",
        "description": null
    }
]

Unsuccessful response sample:

{
    "error": "Invalid API key"
}