GET [ site ]
Production Endpoint:
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/site
Overview
This endpoint shows Site data stored in the ComplyFlow system.
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
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
}
}