GET [ contractor ]
Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/contractor
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/contractor
Overview
This endpoint can be used to retrieve a full list of your company's engaged Contractors/Suppliers for interfacing with other company systems. The response provides the necessary contractor details for your technical team to integrate with external systems (e.g. Power BI dashboards).
The attributes field is only returned by this list endpoint (GET /api/acu/contractor). It is not currently returned by the Get Supplier/Contractor details endpoint (GET /api/acu/contractor/{id}).
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
User should possess both below permissions:
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 |
|
| User ID of the Staff member who owns the contractor relationship. When provided, only contractors owned by that Staff user are returned. | 154 | No |
|
|
Response fields
Each contractor in the returned list includes the following details:
FIELD | TYPE | DESCRIPTION |
|
| Comply Flow contractor ID (internal identifier) |
|
| ABN |
|
| Company name |
|
| |
|
| Trade name of the contractor |
|
| Address |
|
| Postcode |
|
| Contact person |
|
| Contractor status (e.g. Active) |
|
| Phone |
|
| Fax |
|
| Projects the contractor is assigned to |
|
| The latest timestamp when the contractor data was changed in Comply Flow; contains the following attributes: |
|
| Documents with their expiry date; each contains the following attributes: |
|
| Contractor categories |
|
| Contractor Attributes assigned to the contractor — see below |
Contractor Attributes (attributes) — contains a list of attributes assigned to the contractor. Attributes are configured under Configuration → Contractor Attributes and function as labels/tags rather than free-value fields: each entry has a name (the label, e.g. "Manufacturing") and a value, which is always "Yes" (meaning that label is assigned to this contractor). To read a contractor's business function or category, check for the presence of the relevant name in this array — the value does not carry any other data.
"attributes": [
{ "name": "Manufacturing", "value": "Yes" },
{ "name": "Relationship Owner - J. Smith", "value": "Yes" }
]
Common requests and responses
The API request returns the full list of engaged contractors. Example response (one contractor shown):
{
"data": [
{
"id": 1981,
"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": "Active",
"phone": "412 239 399",
"fax": "",
"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": 9774,
"name": "ISO 9001 Certification",
"expiry_date": null
}
],
"contractor_categories": [
"Compliance Management Services"
],
"attributes": [
{ "name": "Manufacturing", "value": "Yes" },
{ "name": "Relationship Owner - J. Smith", "value": "Yes" }
]
}
]
}