Retrieve a list of users

The method and parameters

This method allows obtaining a list of users who can add a camera with an installed Agent.

A required permission level is camera-agents.

GET api/admin/v1/camera-agents/users

The parameters:

string search – the search is carried by a login and a name.

int per_page – a number of elements per page for pagination. By default, 25 elements.

int page – a page number within pagination.

cURL

BASH

curl -k --request POST \
	--url 'https://your-domainapi/admin/v1/camera-agents/users' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "search": "string",
    "per_page": 0,
    "page": 0
}'

PHP

$data = array (
  'search' => 'string',
  '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-domainapi/admin/v1/camera-agents/users', false, $context);

Responses

A detailed list of response codes is in the General description API documentation section.

A successful response:

200 OK

200 OK

Returns a list of users.

JSON

{
    "data": [
        {
            "id": 12,
            "name": "user",
            "login": "user",
            "created_by": null,
            "created_at": "2024-04-09T08:10:45.000000Z",
            "updated_at": "2024-04-09T08:10:45.000000Z",
            "expired_at": null,
            "user_type": "user",
            "parent_id": null,
            "is_system": 0,
            "is_licence_limit_reached": false,
            "ptz_priority": 10,
            "access_token_id": null
        }
    ],
    "links": {
        "first": "https://vms.local:8000/api/admin/v1/camera-agents/users?page=1",
        "last": "https://vms.local:8000/api/admin/v1/camera-agents/users?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:8000/api/admin/v1/camera-agents/users?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8000/api/admin/v1/camera-agents/users",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

Error responses:

401 Unauthorized

The authorization token is invalid or isn’t submitted.

422 Unprocessable Entity

Returns a JSON object with an error.

JSON

{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}