Get Scheduled Inspections | ComplyFlow Help Center

GET [ scheduled-inspection]

Production Endpoint:
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/scheduled-inspection

Overview

This endpoint returns list of scheduled inspections from the current Organisation. The endpoint automatically paginates results to maintain performance. By default, responses include 50 records per page. See sort_by, sort_order, and page in Query Parameters table for Pagination and Sorting.

Authentication instructions

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

Permissions Required

The user should possess the permissions below:

User is Staff
API Access security
Audit R or RW ORG level

Please also refer to the Permissions Overview guide.

Query parameters

FIELD	TYPE	DESCRIPTION	REQUIRED
`sort_by`	`string`	To sort the results by specific column. Accepted values: `scheduled_date,audit_program`
`sort_order`	`string`	To sort the results by ascending or descending order. Accepted values: `asc,desc`
`page`	`integer`	To get results in specific page.

Request Example

curl --location 'http://test.complyflow.com/app/public/index.php/api/acu/scheduled-inspection' \
--header 'Accept: application/json' \
--header 'Authorization: [...]' \
--header 'Cookie: [...];'

Response Example

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE3ODAsImlzcyI6Imh0dHA6Ly9kYXZpZC5jb21wbHlmbG93LmNvbS9hcHAvcHVibGljL2luZGV4LnBocC9hcGkvYWN1L2luc3BlY3Rpb24tYWN0aW9ucyIsImlhdCI6MTc0MDk5NTAwNiwiZXhwIjoxNzQxMDAyMjA2LCJuYmYiOjE3NDA5OTUwMDYsImp0aSI6ImJMUHhVWFJpVzlTVEQ1dU4iLCJpZCI6IlM2MzEiLCJvcmdhbmlzYXRpb25faWQiOjcwfQ.chlI7sLRIA6VWApBupS4TNw7AuNyFpz7bh6t-dKPqXw",
    "data": [
       "data": [
            {
                "id": 197874,
                "contractor_id": null,
                "contractor_name": null,
                "project_id": null,
                "project_name": null,
                "audit_program": "CF TEST",
                "scheduled_date": "2025-05-08",
                "status": "Pending",
                "assigned_to": "Anyone",
                "assigned_staff_id": null,
                "repeats_every": 14,
                "next_inspection_date": null
            },
            {
                "id": 197837,
                "contractor_id": null,
                "contractor_name": null,
                "project_id": null,
                "project_name": null,
                "audit_program": "CF TEST",
                "scheduled_date": "2024-10-10",
                "status": "Overdue",
                "assigned_to": "Bukkos Istvan, Thomas Hopkins, Rick Jordan, Denise Higgins, Chuck Norris, Antonio Conte, Tra Sta, System QA, Mike Adobas, Rea Monta, Ivan Ebuña, AGCard Test 11",
                "assigned_staff_id": "631, 647, 701, 710, 747, 758, 788, 5561, 5794, 5844, 5845, 5902",
                "repeats_every": 12,
                "next_inspection_date": null
            }
        ],
        "pagination": {
            "current_page": 1,
            "total_pages": 1,
            "total_items": 2,
            "per_page": 50
        }
    ],
}

The API will return the following response when there is no scheduled inspection found:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4MDQsImlzcyI6Imh0dHA6Ly9kYXZpZC5jb21wbHlmbG93LmNvbS9hcHAvcHVibGljL2luZGV4LnBocC9hcGkvYWN1L3NjaGVkdWxlZC1pbnNwZWN0aW9uIiwiaWF0IjoxNzQ0Nzc0Mzc1LCJleHAiOjE3NDQ3ODE1NzUsIm5iZiI6MTc0NDc3NDM3NSwianRpIjoiRG1aSm13QzM1NnBNN2R3WiIsImlkIjoiUzY1MSIsIm9yZ2FuaXNhdGlvbl9pZCI6NzF9.zkMEqwqQgy7Ch2zAQ4m_W1gB0EcvvehDaH-MjND3Dao",
    "data": {
        "success": true,
        "message": "No scheduled inspections found."
    }
}