Skip to main content
Skip table of contents

Get the list of intercom users

Get the list of users

Returns a list of users to add to the keys as described in VMS Admin/Intercoms/Keys/Updating keys

GET /api/admin/v1/intercoms/{intercom}/get-users

Parameters

int intercom, Unique identifier of the intercom


int per_page, Number of elements in one pagination page.


int page, Pagination page number


string search

200 OK

Successful response

JSON
{
    "data": [
        {
            "id": 1,
            "name": null,
            "login": "admin@admin.com",
            "created_at": "2019-08-08 19:25:36",
            "updated_at": "2020-06-11 19:40:16",
            "expired_at": null,
            "is_licence_limit_reached": true,
            "ptz_priority": 10,
            "access_token_id": null
        },
        {
            "id": 2,
            "name": "170500",
            "login": "170500",
            "created_at": "2019-08-08 19:25:36",
            "updated_at": "2022-07-28 02:56:37",
            "expired_at": null,
            "is_licence_limit_reached": true,
            "ptz_priority": 10,
            "access_token_id": null
        },
        {
            "id": 18,
            "name": "readonly",
            "login": "readonly@mail.com",
            "created_at": "2019-09-13 19:26:16",
            "updated_at": "2020-06-18 04:11:34",
            "expired_at": null,
            "is_licence_limit_reached": true,
            "ptz_priority": 10,
            "access_token_id": null
        },
        {
            "id": 21,
            "name": "admin",
            "login": "admin@mail.com",
            "created_at": "2019-09-13 19:26:16",
            "updated_at": "2022-10-18 12:16:00",
            "expired_at": null,
            "is_licence_limit_reached": true,
            "ptz_priority": 10,
            "access_token_id": null
        },
        {
            "id": 30,
            "name": "billing",
            "login": "billing",
            "created_at": "2019-09-18 18:10:15",
            "updated_at": "2022-10-18 12:16:00",
            "expired_at": null,
            "is_licence_limit_reached": true,
            "ptz_priority": 10,
            "access_token_id": null
        }
    ],
    "links": {
        "first": "https://vms.local:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=1",
        "last": "https://vms.local:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=50253",
        "prev": null,
        "next": "https://vms.local:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 50253,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=2",
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local:8080/api/admin/v1/intercoms/31/get-users",
        "per_page": 5,
        "to": 5,
        "total": 251265
    }
}

401 Unauthorized

Authorization token not sent or not valid

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/{intercom}/get-users' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "intercom": 0,
    "per_page": 0,
    "page": 0,
    "search": "string"
}'
PHP
PHP
$data = array (
  'intercom' => 0,
  'per_page' => 0,
  'page' => 0,
  'search' => 'string',
);
$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/intercoms/{intercom}/get-users', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.