Skip to main content
Skip table of contents

Intercom apartment

GET/api/admin/v1/intercoms/{intercom}/flats/{flat}
Headers
Authorization
Bearer token
Accept
application/json
X-Client
ios-cctv|android-cctv|thick-legal|web
X-UUID
unique device id
Response
200
Successful response
JSON
{
                "id": 1,
                "flat": 1,
                "key_count": 3,
                "users_count": 2,
                "keys": [
                    {
                        "id": 1,
                        "key": "0000003042CAAC",
                        "user": {
                            "id": 6,
                            "name": "user",
                            "login": "user@mail.com",
                            "created_at": "2022-11-11 14:45:58",
                            "updated_at": "2022-11-11 14:45:58",
                            "expired_at": "2122-11-11 14:45:57",
                            "is_licence_limit_reached": false,
                            "ptz_priority": 1,
                            "access_token_id": null
                        },
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    },
                    {
                        "id": 2,
                        "key": "000000A3B48D3C",
                        "user": {
                            "id": 6,
                            "name": "user",
                            "login": "user@mail.com",
                            "created_at": "2022-11-11 14:45:58",
                            "updated_at": "2022-11-11 14:45:58",
                            "expired_at": "2122-11-11 14:45:57",
                            "is_licence_limit_reached": false,
                            "ptz_priority": 1,
                            "access_token_id": null
                        },
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    },
                    {
                        "id": 4,
                        "key": "000000417EE9AA",
                        "user": null,
                        "created_at": "2022-11-11 14:46:16",
                        "updated_at": "2022-11-14 15:56:40"
                    }
                ],
                "users": [
                    {
                        "id": 5,
                        "name": "user",
                        "login": "user@mail.com",
                        "created_at": "2022-11-11 14:45:57",
                        "updated_at": "2022-11-11 14:45:57",
                        "expired_at": "2122-11-11 14:45:57",
                        "is_licence_limit_reached": false,
                        "ptz_priority": 1,
                        "access_token_id": null
                    },
                    {
                        "id": 6,
                        "name": "user",
                        "login": "user@mail.com",
                        "created_at": "2022-11-11 14:45:58",
                        "updated_at": "2022-11-11 14:45:58",
                        "expired_at": "2122-11-11 14:45:57",
                        "is_licence_limit_reached": false,
                        "ptz_priority": 1,
                        "access_token_id": null
                    }
                ],
                "properties": {
                    "is_analog_line_enable": true,
                    "is_sip_line_enable": true,
                    "is_combined_enable": false,
                    "is_can_manage_resistance": true
                }
            }
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/{intercom}/flats/{flat}' \
--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.