List of administrators

Getting a list of administrators

Returns a list of administrators.

GET /api/admin/v1/admins

Method parameters

int search, search by administrator's login and name

bool paginate, apply pagination

int per_page, number of items per pagination page. Default is 25

int page, pagination page number

200 OK

Successful response

JSON

{
    "data": [
        {
            "id": 87,
            "name": "Name",
            "login": "user@mail.com",
            "created_at": "2022-03-24 11:26:58",
            "updated_at": "2022-03-30 16:48:54",
            "expired_at": null,
            "is_licence_limit_reached": false,
            "ptz_priority": 10,
            "access_token_id": null
        },
        {
            "id": 8,
            "name": "Name",
            "login": user@mail.com",
            "created_at": "2021-06-03 17:32:13",
            "updated_at": "2021-06-03 17:32:13",
            "expired_at": null,
            "is_licence_limit_reached": false,
            "ptz_priority": 10,
            "access_token_id": null
        }
    ],
    "links": {
        "first": "https://vms.local/api/admin/v1/admins?per_page=25&search=1&page=1",
        "last": "https://vms.local/api/admin/v1/admins?per_page=25&search=1&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/admin/v1/admins?per_page=25&search=1&page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/admin/v1/admins",
        "per_page": 25,
        "to": 2,
        "total": 2
    }
}

401 Unauthorized

Authorization token is not passed or invalid. Obtaining a token

cURL

BASH

curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/admins' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "search": 0,
    "paginate": true,
    "per_page": 0,
    "page": 0
}'

PHP

$data = array (
  'search' => 0,
  'paginate' => true,
  'per_page' => 0,
  'page' => 0,
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/admins', false, $context);