Skip to main content
Skip table of contents

List of users

Get the list of users to add to the keys, see Keys update

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

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

intercomoptional

int

Unique identifier of the intercom

per_pagerequired

int

Number of items per page for pagination. Default is 25

pagerequired

int

Page number for pagination

searchrequired

string

Response

200

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": "user",
                        "login": "user",
                        "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": "user",
                        "login": "user@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": "user",
                        "login": "user",
                        "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": "http://127.0.0.1:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=1",
                    "last": "http://127.0.0.1:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=50253",
                    "prev": null,
                    "next": "http://127.0.0.1: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": "http://127.0.0.1:8080/api/admin/v1/intercoms/31/get-users?per_page=5&page=2",
                            "label": "pagination.next",
                            "active": false
                        }
                    ],
                    "path": "http://127.0.0.1:8080/api/admin/v1/intercoms/31/get-users",
                    "per_page": 5,
                    "to": 5,
                    "total": 251265
                }
            }
401

Authorization token is not provided or is invalid. Obtaining a token

Example

JSON
curl -k --location --request GET 'https://vms.local/api/admin/v1/intercoms/{intercom}/get-users?per_page=int&page=int&search=string' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

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

If this problem persists, please contact our support.