GET [ site ]

Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/site
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/site

Overview

This endpoint returns every Site in your organisation, sorted by site name. Archived sites and sites whose end date has passed are included. There are no query parameters, filters or pagination: one call returns the full list, and totalCount is the number of sites returned.

Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user should possess the permissions below:

API User
User is Staff
Users have Access to View Site Permission

Please also refer to the Permissions Overview guide.

Body properties/Payload

None. This endpoint takes no query parameters and no request body; anything sent is ignored.

FIELD	TYPE	DESCRIPTION	REQUIRED
-	-	-	-

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/site' \
--header 'Content-Type: application/json' \
--header 'Authorization: ...' \
--header 'Cookie: ...'

Response Example

{
    "token": "",
    "data": {
        "success": true,
        "sites": [
            {
                "siteId": 46,
                "siteName": "ProjectD",
                "code": "PD",
                "address": "Jln D",
                "state": "Pekan Baru",
                "postCode": "50112",
                "country": "Argentina",
                "timezone": "America/New_York",
                "startDate": "2024-03-28",
                "endDate": "2035-09-01",
                "labels": [
                  "Default Project Label"
                ],
                "isActive": true,
                "siteContact": {
                    "staffId": 692,
                    "staffName": "wr er"
                },
                "currentDocuments": 4,
                "pendingDocuments": 1,
                "expiredDocuments": 0
            },
            ...
        ],
        "totalCount": 23,
        "statusCode": 200
    }
}

Response notes

startDate and endDate are the dates entered on the Site. endDate is null when no end date has been set.
isActive is true when the Site is not archived and its endDate is empty or in the future. It is false for archived Sites and for Sites whose end date has passed; the response does not distinguish between the two, and the date a Site was archived is not returned.
siteContact is null when no site contact is set.

Get Site List