Get a list of intercom flats | AIPIX documentation

The method and parameters

Retrieves the list of flats for a given intercom. The intercom can be specified by its ID. Supports search by flat number as well as by user details (login, name). Pagination is available.

GET /api/v1/billing/intercom-flats

int intercom_id – an intercom ID

string search – search query (optional)

int per_page – items per page (default – 25, maximum – 100)

200 OK

Successful response

JSON

{
    "data": [
        {
            "id": 10,
            "flat": 12,
            "key_count": 0,
            "users_count": 0,
            "intercom_id": 1,
            "properties": {
                "is_smartphone_sip_line_available": true,
                "is_landline_sip_line_available": false,
                "is_analog_line_available": true
            }
        }
    ],
    "links": {
        "first": "...",
        "last": "...",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "...",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}

422 Unprocessable Entity

Returns a JSON object with an error. For details, see General information/External system validation.

JSON

{
    "message": "No error message here",
    "errors": {
        "any_key": [
            "Error details"
        ]
    }
}

cURL

Bash

curl -k --request GET \
	--url 'https://your-domain/api/v1/billing/intercom-flats' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '{
    "intercom_id": 0,
    "search": "string",
    "per_page": 0
}'

PHP

$data = array (
  'intercom_id' => 0,
  'search' => 'string',
  'per_page' => 0,
);
$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/v1/billing/intercom-flats', false, $context);