GET [ work-order ]
Production Endpoint:
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/work-order
Overview
This endpoint returns the list of Work Orders from the current organisation.
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
User have View Supplier Permission (minimum)
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | EXAMPLE | REQUIRED | DEFAULT | PATTERN |
|
| Status (can be multiple with a comma) |
| No |
| 0 → Pending 1 → New 2 → In Progress 4 → Completed 7 → Cancelled |
|
| The start date of the last updated filter |
| No |
|
|
|
| The end date of the last updated filter |
| No |
|
|
|
| The start date of the completion date filter |
| No |
|
|
|
| The end date of the completion date filter |
| No |
|
|
Request Example
curl --location 'http://test.complyflow.com.au/app/public/index.php/api/work-order?status=0%2C2&last_updated_from=2025-01-01&last_updated_to=2025-01-02&completion_date_from=2025-01-01&completion_date_to=2025-01-02'' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'
Response Example
The API Request returns a list of staff from the current organisation:
{
"token": "",
"data": {
"StatusCode": 200,
"Message": "Work Orders fetched successfully.",
"Data": [
{
"CFWOID": 253,
"WONumber": "WO1",
"WorkRef": "Postman1",
"Type": "Maintenance",
"Description": "Brief description of the work order",
"Priority": "Low",
"WorkOrderActive": 0,
"Status": 0,
"LastUpdated": "2025-01-17 15:58:37",
"CompletionDate": "2025-01-01"
},
{
"CFWOID": 257,
"WONumber": "WO2",
"WorkRef": "Postman2",
"Type": "Maintenance",
"Description": "Brief description of the work order",
"Priority": "Low",
"WorkOrderActive": 0,
"Status": 0,
"LastUpdated": "2025-01-20 17:43:00",
"CompletionDate": "2025-01-01"
}
]
}
}