This documentation is still a work in progress. Please contact Support to register for early access.

Get Overview

Developing

GET

https://api.portierx.com/api/v1/access-control-systems/overview

List of all connected access control systems

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200OK

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.portierx.com/api/v1/access-control-systems/overview?building_id' \
--header 'Authorization: <api-key>'

Response Example

{
    "msg": "Retrieved item successfully",
    "data": [
        {
            "brand": "Manufacturer Name",
            "creation_system": "portier-guardian",
            "codename": "My Office",
            "data_delivery_id": "QsXaDC",
            "product": "Product Name",
            "description": "A description",
            "revision_number": "0",
            "system_type": "GHS",
            "system_technology": "Mechanical",
            "history_date": {
                "Initial Request": "string",
                "Initial Installation": "string",
                "Order Date": "2025-01-01",
                "Manufacture Date": "2025-01-12",
                "Instalation Date": "2025-02-20"
            },
            "notes": "\n\n",
            "summary": {
                "total_access_credentials": 608,
                "total_access_credential_copies": 1216,
                "total_access_points": 1184,
                "total_buildings": 1,
                "total_spaces": 1
            },
            "id": "string"
        }
    ]
}

Modified at 2025-08-25 05:23:15

UNAUTHORIZED

Locking Plan