Intercom key list

GET/api/admin/v1/intercoms/{intercom}/keys

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
per_page^required	int	Number of items per pagination page. Default is 25
page^required	int	Pagination page number
search^required	string
sort^required	string	Field by which to sort the servers
dir^required	string	Direction of sorting. desc – from highest to lowest, asc – from lowest to highest
from^required	date	Start of the time interval
to^required	date	End of the time interval
user_id^required	integer	Filter by user
exclude_keys_id^required	array	List of keys to exclude
unbound_users^required	bool	true – Get only keys that are not assigned to users false – Get keys assigned to users
unbound_flats^required	bool	true – Get only keys that are not assigned to an apartment false – Get keys assigned to an apartment
intercom_flat_id^required	integer	Get all keys of the apartment

Response
200		Successful response
JSON { "data": [ { "id": 1, "key": "0000003042CAAC", "user": null, "flat": { "id": 1, "flat": 1, "key_count": null, "users_count": null, "number": "user@vms.local", "duplicate_number": "ххххххххххх", "is_duplicated_sip_line_available": true, "is_analog_line_enable": false, "is_sip_line_enable": false }, "created_at": "2022-11-11 14:46:16", "updated_at": "2022-11-11 14:46:16" }, { "id": 2, "key": "000000A3B48D3C", "user": null, "flat": null, "created_at": "2022-11-11 14:46:16", "updated_at": "2022-11-11 14:46:16" }, { "id": 3, "key": "000000418D363A", "user": null, "flat": null, "created_at": "2022-11-11 14:46:16", "updated_at": "2022-11-11 14:46:16" }, { "id": 4, "key": "000000417EE9AA", "user": null, "flat": null, "created_at": "2022-11-11 14:46:16", "updated_at": "2022-11-11 14:46:16" }, { "id": 5, "key": "0000003043CAAC", "user": null, "flat": null, "created_at": "2022-11-14 14:26:40", "updated_at": "2022-11-14 14:26:40" } ], "links": { "first": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=1", "last": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2", "prev": null, "next": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 2, "links": [ { "url": null, "label": "pagination.previous", "active": false }, { "url": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=1", "label": "1", "active": true }, { "url": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2", "label": "2", "active": false }, { "url": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys?per_page=5&page=2", "label": "pagination.next", "active": false } ], "path": "http://127.0.0.1:8080/api/admin/v1/intercoms/1/keys", "per_page": 5, "to": 5, "total": 8 } }
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/{intercom}/keys?per_page=int&page=int&search=string&sort=string&dir=string&from=date&to=date&user_id=integer&exclude_keys_id=array&unbound_users=bool&unbound_flats=bool&intercom_flat_id=integer' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'