Skip to main content
Skip table of contents

List of intercoms in the group

GET/api/admin/v1/intercoms/groups/{group}

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

groupoptional

int

Unique identifier of the group

per_pagerequired

int

Number of items per pagination page. Default is 25

pagerequired

int

Pagination page number

vendorrequired

string

Filter by model. In Main configurations under the key intercom_vendors

statusrequired

string

Filter by status. In Main configurations under the key intercom_statuses

fromrequired

date

Start of time interval

torequired

date

End of time interval

department_typerequired

string

Filter by input type. In VMS Main configurations under the key intercom_statuses

searchrequired

string

Search by uuid, title, address, mac

sortrequired

string

Field to sort the reactions by

dirrequired

string

Direction of sorting. desc - from largest to smallest, asc - from smallest to largest

Response

200

Successful response

JSON
[
    {
        "id": 364,
        "title": "Intercom 1",
        "is_online": true,
        "group_id": 145,
        "camera_id": 831,
        "flat_from": 1,
        "flat_to": 50,
        "department": 1,
        "uuid": "e7a06b0d-512b-4d10-8866-11d277fa7f0a",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-21T11:18:44.000000Z"
    },
    {
        "id": 366,
        "title": "Intercom 2",
        "is_online": true,
        "group_id": 145,
        "camera_id": 832,
        "flat_from": 1,
        "flat_to": 50,
        "department": 3,
        "uuid": "701cb632-e0c6-463d-9599-b0ba8945492d",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-23T09:50:37.000000Z"
    },
    {
        "id": 370,
        "title": "Intercom 3",
        "is_online": true,
        "group_id": 145,
        "camera_id": 833,
        "flat_from": 1,
        "flat_to": 50,
        "department": 2,
        "uuid": "e276308c-eed3-4376-98e6-6702debc19ec",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-23T10:11:24.000000Z"
    },
    {
        "id": 369,
        "title": "Intercom 4",
        "is_online": false,
        "group_id": 145,
        "camera_id": 836,
        "flat_from": 1,
        "flat_to": 50,
        "department": 6,
        "uuid": "7b23d697-04db-4d00-ab88-fae8846bf9af",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-22T15:00:13.000000Z"
    },
    {
        "id": 368,
        "title": "Intercom 5",
        "is_online": true,
        "group_id": 145,
        "camera_id": 837,
        "flat_from": 1,
        "flat_to": 50,
        "department": 7,
        "uuid": "2d68b836-6f27-4650-8dae-9e80ff9bd26f",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-22T15:01:06.000000Z"
    },
    {
        "id": 365,
        "title": "Intercom 6",
        "is_online": false,
        "group_id": 145,
        "camera_id": 835,
        "flat_from": 1,
        "flat_to": 50,
        "department": 4,
        "uuid": "272cc71e-6b7f-44b6-93b2-2d5ce551e482",
        "created_at": "2022-05-27T11:26:59.000000Z",
        "updated_at": "2022-06-22T13:13:39.000000Z"
    }
]
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/groups/{group}?per_page=int&page=int&vendor=string&status=string&from=date&to=date&department_type=string&search=string&sort=string&dir=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.