Skip to main content
Skip table of contents

An intercom apartment

An intercom apartment

GET /api/admin/v1/intercoms/{intercom}/flats/{flat}

200 OK

Successful response

JSON
{
    "id": 1,
    "flat": 1,
    "key_count": 3,
    "users_count": 2,
    "keys": [
        {
            "id": 1,
            "key": "0000003042CAAC",
            "user": {
                "id": 6,
                "name": "test",
                "login": "test@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": "test",
                "login": "test@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": "test",
            "login": "test@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_can_manage_resistance": true
    }
}

401 Unauthorized

Authorization token not sent or not valid

422 Unprocessable Entity

Returns a JSON object with an error.

JSON
{
    "message": "There will be no informative message here",
    "errors": {
        "any_key": [
            "The cause of the error will be described here"
        ]
    }
}
cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/admin/v1/intercoms/{intercom}/flats/{flat}' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '[]'
PHP
PHP
$data = array (
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/admin/v1/intercoms/{intercom}/flats/{flat}', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.