Skip to main content

Get Plant Category List

Written by Support

GET [ plant-categories ]

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

Overview

This endpoint returns the list of Plant Categories configured in your organisation, sorted by name.

Use the Plant Category IDs it returns to request the compliance reports for each Plant Category. Refer to Get Plant Compliance Report (Required Document Categories per Plant item) and Get Operator Competency Compliance Report (Operator Competencies per Staff User).

If you can't find what you are looking for or need further assistance, please contact support@complyflow.com.au

Authentication instructions

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

Permissions Required

  • API User

  • User is Staff

  • Plant & Vehicles > View Plant & Vehicles (or Manage Plant & Vehicles), or Super User

Please also review the Permissions Overview guide.

Query parameters

None

Request Example

curl --location 'https://test.complyflow.com.au/app/public/index.php/api/acu/plant-categories' \
--header 'Authorization: Bearer {token}'

Response Example

The API request returns every Plant Category in your organisation:

{
  "token": "refreshed_jwt_token",
  "data": [
    { "id": 8, "name": "Earthmoving Equipment" },
    { "id": 12, "name": "Elevated Work Platforms" },
    { "id": 5, "name": "Forklifts" }
  ]
}

Response Fields

Field Name

Type

Description

id

integer

Plant Category ID. Pass it as category_id to Get Plant Compliance Report, or as plant_category_id to Get Operator Competency Compliance Report

name

string

Plant Category name

Error Responses

Errors are returned with HTTP status 200 in the standard response format, with the error details inside data, for example { "token": "...", "data": { "status": false, "error": "Access denied", "error_code": 20 } }. Token errors are returned before the request reaches ComplyFlow, with the HTTP status shown.

Scenario

Response

No API access, not a Staff User, or no Plant & Vehicles permission

{ "status": false, "error": "Access denied", "error_code": 20 }

No token supplied

HTTP 400 { "error": "token_not_provided" }

Token has expired

HTTP 401 { "error": "token_expired" }

Token is invalid, or has already been replaced by a refreshed token

HTTP 400 or 401 { "error": "token_invalid" }

Notes

  • All results are scoped to your organisation via the JWT token

  • Each response returns a refreshed token. Use it for your next request

  • An empty data array means no Plant Categories are configured in your organisation

  • To list Staff Categories instead, refer to Staff Category Compliance Report

Did this answer your question?