Skip to main content
Skip table of contents

Intercom tree. VMS Admin API

GET/api/admin/v1/intercoms/tree

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

searchrequired

int

The search is performed by:

  1. Branch name

  2. Intercom ID

  3. Intercom MAC address

  4. Device address

group_idrequired

int

In case you need to see the contents of a group (groups that are inside)

Response

200

Successful response

JSON
[
    {
        "id": 139,
        "name": "City",
        "full_pretty": null,
        "is_house": 0,
        "cameras_count": 28,
        "parent_id": null,
        "csa_id": 17030,
        "intercoms_count": 7
    }
]
401

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

422

Returns a JSON object with an error. Validation

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The reason for the error will be described here"
        ]
    }
}

Example

JSON
curl -k --location --request GET 'https://vms.local/api/admin/v1/intercoms/tree?search=int&group_id=int' \
--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.