GET [ contractor/{id} ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/contractor/{id}
Test Endpoint: Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/contractor/{id}
Overview
This endpoint can be used to fetch the details for a single Contractor/Supplier to interface with other company systems, including key company information (e.g. ABN, address) and an array of the company’s documents (e.g., ID, name, expiry).
Authentication instructions
Refer to the Authentication method for Authentication Methods (for Login and Logout).
Permissions Required
User should posses both below permission:
API User
Companies > View Supplier Company Details (previously Contractors R)
Please also refer to the Permissions Overview guide.
Query parameters
FIELD | TYPE | DESCRIPTION | Example | REQUIRED | DEFAULT | PATTERN |
|
| contractor ID | 1981 | Yes |
|
|
Common requests and responses
The API request returns all details for that contractor:
"data": {
"id": 1981,
"contractor_organisation_id": 3304,
"abn": "44 265 999 888",
"company_name": "Comply Flow Pty Ltd",
"email": "cfdemo-ib-samantha@complyflow.com",
"trade_name": "Comply Flow",
"address": "Mainly Road",
"postcode": "2095",
"contact_name": "Samantha McAndrew",
"status": "Document Expired",
"phone": "412 239 399",
"fax": "87432942937592",
"project": [
"Laravel Update"
],
"timestamp": {
"date": "2024-04-09 20:58:25.000000",
"timezone_type": 3,
"timezone": "Australia/Sydney"
},
"documents": [
{
"id": 9772,
"name": "Insurance - Professional Indemnity",
"expiry_date": {
"date": "2024-04-08 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Sydney"
}
},
{
"id": 9773,
"name": "Insurance - Workers Compensation",
"expiry_date": {
"date": "2027-04-08 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Sydney"
}
},
{
"id": 9774,
"name": "ISO 9001 Certification",
"expiry_date": null
},
{
"id": 9776,
"name": "Insurance - Public Liability",
"expiry_date": {
"date": "2024-04-30 00:00:00.000000",
"timezone_type": 3,
"timezone": "Australia/Sydney"
}
}
],
"contractor_categories": [
"Compliance Management Services"
]
}
}