Skip to main content
Skip table of contents

List of houses

List of all groups that have is_house = true related to the current user

GET/api/admin/v1/intercoms/house-groups

Headers

Authorization

Bearer token

Accept

application/json

X-Client

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

X-UUID

unique device id

Body

per_pagerequired

int

Number of items per pagination page. Default is 25 items

pagerequired

int

Pagination page number

Response

200

List of groups

JSON
{
    "data": [
        {
            "id": 217498,
            "name": "intercom_sub_4",
            "full_pretty": null,
            "is_house": 1,
            "cameras_count": 0,
            "parent_id": 217497,
            "csa_id": null,
            "intercoms_count": 0
        }
    ],
    "links": {
        "first": "http://127.0.0.1:8080/api/admin/v1/intercoms/house-groups?page=1",
        "last": "http://127.0.0.1:8080/api/admin/v1/intercoms/house-groups?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "http://127.0.0.1:8080/api/admin/v1/intercoms/house-groups?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "http://127.0.0.1:8080/api/admin/v1/intercoms/house-groups",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}
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/house-groups?per_page=int&page=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.