Get Plant List (with Sites) | ComplyFlow Help Center

GET [ plant ]

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

Overview

This endpoint returns the list of Plant or Vehicles attached to the current Organisation.

Authentication instructions

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

Permissions Required

The user will required the permissions below:

API User
User is Staff
Users have View Contractor Permission

Please also refer to the Permissions Overview guide.

Query parameters

FIELD	TYPE	DESCRIPTION	Example	REQUIRED	DEFAULT	PATTERN
`Site`	`comma-separated integer`	Site ID	`30,31,32`	NO	`null`	`^(?:\d+)(?:,\d+)*$`

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/plant?Site=35%2C41' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'

Response Example

The API Request returns list of Plant or Vehicles attached to the current organisation.

{
    "token": "",
    "data": [
        {
            "id": 70,
            "contractor_id": 1554,
            "company_name": "asda123123123123123",
            "make": "YES",
            "model": "YES-123x",
            "type": "BMW",
            "year_of_manufacture": 2023,
            "serial_number": "14236666",
            "sticker_id": "",
            "owned_by": "wr er",
            "plant_categories": [
                {
                    "id": 12,
                    "name": "PlantA",
                    "status": "Pending"
                }
            ],
            "documents": [
                {
                    "id": 166,
                    "name": "DocA2"
                }
            ],
            "sites": [
                {
                    "id": 41,
                    "name": "projecta"
                }
            ]
        }
    ]
}