Skip to main content
Skip table of contents

List of users for events and reactions

Pagination list of users who will receive reactions, including sub-users and parent user.

GET/api/v1/scripts/users

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

pagerequired

int

Pagination page number

per_pagerequired

int

Number of items per pagination page. Default is 25

exclude_users_idsrequired

array

Array of user IDs. Excluded IDs will not be reflected in the output

Response

200

Returns a list of users on page i of the pagination

JSON
{
    "data": [
        {
            "id": 55,
            "login": "user@mail.com",
            "name": "user",
            "parent_id": 3,
            "created_at": "2021-12-16 18:14:50",
            "updated_at": "2022-06-17 12:04:06",
            "access_token_id": null,
            "can_update_password": false
        }
    ],
    "links": {
        "first": "https://vms.local/api/v3/scripts/users?page=1",
        "last": "https://vms.local/api/v3/scripts/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/api/v3/scripts/users?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v3/scripts/users",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}
401

Authorization token not provided or invalid, see Obtaining a token

422

Returns a JSON object with an error, see Validation

JSON
{
    "message": "There won't be any informative message here",
    "errors": {
        "any_key": [
            "Here the error cause will be described"
        ]
    }
}

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/scripts/users?page=int&per_page=int&exclude_users_ids=array' \
--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.