Skip to main content
Skip table of contents

List of all intercoms

GET/api/admin/v1/intercoms

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

per_pagerequired

int

Number of items per pagination page. Default is 25

pagerequired

int

Pagination page number

searchrequired

string

Number of items per pagination page. Default is 25

sortrequired

string

Field by which servers should be sorted

dirrequired

string

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

vendorrequired

string

Filtering by model. In the Main configurations under the key intercom_vendors

statusrequired

string

Filtering by status. In the Main configurations under the key intercom_statuses

fromrequired

date

Start of time interval

torequired

date

End of time interval

department_typerequired

string

Filter by entry type. In the Main configurations under the key intercom_statuses

Response

200

Successful response

JSON 
{
    "data": [
        {
            "id": 28,
            "title": null,
            "is_online": false,
            "group_id": null,
            "camera_id": null,
            "flat_from": null,
            "flat_to": null,
            "flat_offset": null,
            "department": null,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "7b23d697-04db-4d00-ab88-fae8846bf9af",
            "address": null,
            "group": null,
            "created_at": "2022-08-24 16:16:12",
            "updated_at": "2022-08-24 16:16:12",
            "mac": "02:A9:D0:3F:1B:63",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "uninstalled",
            "status_pretty": "Not installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 29,
            "title": null,
            "is_online": false,
            "group_id": null,
            "camera_id": null,
            "flat_from": null,
            "flat_to": null,
            "flat_offset": null,
            "department": null,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "272cc71e-6b7f-44b6-93b2-2d5ce551e482",
            "address": null,
            "group": null,
            "created_at": "2022-08-24 16:16:12",
            "updated_at": "2022-08-24 16:16:12",
            "mac": "02:A2:DD:63:1A:55",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "uninstalled",
            "status_pretty": "Not installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 25,
            "title": null,
            "is_online": false,
            "group_id": null,
            "camera_id": null,
            "flat_from": null,
            "flat_to": null,
            "flat_offset": null,
            "department": null,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "017f4d15-6dd8-48b6-968e-b0f23740c517",
            "address": null,
            "group": null,
            "created_at": "2022-08-24 16:16:11",
            "updated_at": "2022-08-24 16:16:11",
            "mac": "02:40:0D:B3:0A:FE",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "uninstalled",
            "status_pretty": "Not installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 26,
            "title": "qwerty",
            "is_online": false,
            "group_id": 217498,
            "camera_id": 6180,
            "flat_from": 10,
            "flat_to": 20,
            "flat_offset": null,
            "department": 2,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "2d68b836-6f27-4650-8dae-9e80ff9bd26f",
            "address": "intercom_sub_2, intercom_sub_3, intercom_sub_4",
            "group": {
                "id": 217498,
                "name": "intercom_sub_4",
                "full_pretty": "intercom_main, intercom_sub_1, intercom_sub_2, intercom_sub_3, intercom_sub_4",
                "is_house": 1,
                "cameras_count": 0,
                "parent_id": 217497,
                "csa_id": null,
                "intercoms_count": 0
            },
            "created_at": "2022-08-24 16:16:11",
            "updated_at": "2022-08-24 16:16:11",
            "mac": "02:03:42:31:7C:79",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "installed",
            "status_pretty": "Installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 27,
            "title": null,
            "is_online": false,
            "group_id": null,
            "camera_id": null,
            "flat_from": null,
            "flat_to": null,
            "flat_offset": null,
            "department": null,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "e276308c-eed3-4376-98e6-6702debc19ec",
            "address": null,
            "group": null,
            "created_at": "2022-08-24 16:16:11",
            "updated_at": "2022-08-24 16:16:12",
            "mac": "02:E2:6B:66:E3:7D",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "uninstalled",
            "status_pretty": "Not installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 23,
            "title": null,
            "is_online": false,
            "group_id": 217498,
            "camera_id": 6158,
            "flat_from": 10,
            "flat_to": 40,
            "flat_offset": null,
            "department": 3,
            "department_name": null,
            "department_type": "main",
            "department_type_pretty": "Entrance",
            "uuid": "e7a06b0d-512b-4d10-8866-11d277fa7f0a",
            "address": "intercom_sub_2, intercom_sub_3, intercom_sub_4",
            "group": {
                "id": 217498,
                "name": "intercom_sub_4",
                "full_pretty": "intercom_main, intercom_sub_1, intercom_sub_2, intercom_sub_3, intercom_sub_4",
                "is_house": 1,
                "cameras_count": 0,
                "parent_id": 217497,
                "csa_id": null,
                "intercoms_count": 0
            },
            "created_at": "2022-08-24 16:16:10",
            "updated_at": "2022-09-20 12:09:03",
            "mac": "02:DC:87:CE:0C:F7",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "installed",
            "status_pretty": "Installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        },
        {
            "id": 24,
            "title": null,
            "is_online": false,
            "group_id": null,
            "camera_id": null,
            "flat_from": null,
            "flat_to": null,
            "flat_offset": null,
            "department": null,
            "department_name": null,
            "department_type": null,
            "department_type_pretty": null,
            "uuid": "701cb632-e0c6-463d-9599-b0ba8945492d",
            "address": null,
            "group": null,
            "created_at": "2022-08-24 16:16:10",
            "updated_at": "2022-08-24 16:16:11",
            "mac": "02:43:1A:2E:CF:D2",
            "vendor": "sputnik",
            "vendor_pretty": "Sputnik",
            "status": "uninstalled",
            "status_pretty": "Not installed",
            "switch": "metakom",
            "switch_pretty": "Metakom"
        }
    ],
    "links": {
        "first": "http://127.0.0.1:8080/api/admin/v1/intercoms?page=1",
        "last": "http://127.0.0.1:8080/api/admin/v1/intercoms?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8080/api/admin/v1/intercoms?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "http://127.0.0.1:8080/api/admin/v1/intercoms",
        "per_page": 15,
        "to": 7,
        "total": 7
    }
}
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?per_page=int&page=int&search=string&sort=string&dir=string&vendor=string&status=string&from=date&to=date&department_type=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.

Contact Support Close