Visit Main Site
Join Partner Program
Login
     
Introduction
Authentication
Documentation
Account
GET
POST
PUT
PATCH
DELETE
Item
GET
POST
DELETE
PATCH
Item Fulfillment
GET
POST
PATCH
Item Receipts
GET
POST
PATCH
DELETE
Order
GET
POST
PATCH
PUT
DELETE
Subscription
Usage
GET
POST
PATCH
PUT
DELETE
Express
POST
Invoice
GET
POST
PATCH
DELETE
Payment
GET
POST
PATCH
DELETE
Credit Note
GET
PATCH
Refund
GET
POST
PATCH
DELETE
Purchase Order
GET
POST
DELETE
PATCH
Purchase Invoice
GET
POST
PATCH
DELETE
Purchase Payment
GET
POST
DELETE
PATCH
Purchase Credit Note Applications
GET
PATCH
Purchase Refund
GET
POST
DELETE
Gift Certificate
GET
POST
PATCH
DELETE
Return Merchandise Authorizations
GET
POST
RVA
GET
POST
Settings
GET
POST
PATCH
Integration
GET
POST
PATCH
DELETE
Portal
POST
Communications
GET
POST
Reports
GET
Proforma
GET
POST
Labour
GET
POST
PATCH
DELETE
Workflow
GET
POST
PATCH
DELETE
Labour Profiles
GET
POST
PATCH
DELETE
Custom Objects
GET
Rental Asset Profiles
GET
POST
PATCH
DELETE
User settings
GET
Task
GET
POST
PATCH
DELETE
Custom Development
Custom Component
GET
POST
PATCH
DELETE
Custom Attribute
GET
PATCH
Custom Object
GET
POST
PATCH
Custom Database
GET
POST
Custom Component Notes
GET
POST
» Labour GET API Documentation

Retrieve Labour List: /labours

GET
https://dev-api.exsited.com/api/v3/labours
Try It Out
Purpose

This endpoint is used to retrieve a paginated list of labours configured in the system. It provides comprehensive information about each labour resource, including profile association, availability configuration, custom availability schedules, and metadata required for workforce planning, scheduling, and assignment.

Use Case

• Fetching all active labours for workforce allocation.
• Displaying labour details in scheduling or dispatch modules.
• Validating labour availability before assigning jobs or tasks.
• Reviewing labour profiles and custom availability settings.
• Integrating labour data into third-party workforce or calendar systems.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters
AttributeTypeDescription
limitintegerNumber of records to return per page.
offsetintegerNumber of records to skip before returning results.
Request Body

This endpoint does not require a request body.

Response

The API returns a paginated list of labour records, each containing core labour details such as identifiers, status, profile association, custom form template, availability settings, and audit metadata. Each labour entry may include custom availability schedules specifying preferred working days and time ranges, along with links to associated labour profiles. Pagination information is also included to support efficient data retrieval and navigation through large datasets.

Response Body
JSON
{
    "labours": [
        {
            "status": "LABOUR_STATUS",
            "uuid": "LABOUR_UUID",
            "code": "LABOUR_CODE",
            "name": "LABOUR_NAME",
            "display_name": "LABOUR_DISPLAY_NAME",
            "description": "LABOUR_DESCRIPTION",
            "image_name": "IMAGE_NAME",
            "email_address": "EMAIL_ADDRESS",
            "use_custom_availability": "USE_CUSTOM_AVAILABILITY",
            "labour_profile": {
                "status": "PROFILE_STATUS",
                "uuid": "PROFILE_UUID",
                "name": "PROFILE_NAME",
                "display_name": "PROFILE_DISPLAY_NAME",
                "link": "PROFILE_LINK"
            },
            "custom_form_template": "CUSTOM_FORM_TEMPLATE",
            "created_by": "CREATED_BY",
            "created_on": "CREATED_ON",
            "last_updated_by": "LAST_UPDATED_BY",
            "last_updated_on": "LAST_UPDATED_ON",
            "custom_attributes": [],
            "labour_contacts": [],
            "labour_custom_availability": [
                {
                    "status": "AVAILABILITY_STATUS",
                    "uuid": "AVAILABILITY_UUID",
                    "start_time": "START_TIME",
                    "end_time": "END_TIME",
                    "available": "AVAILABLE_FLAG",
                    "preferred_day": "PREFERRED_DAY"
                }
            ],
            "labour_availability": []
        }
    ],
    "pagination": {
        "records": "TOTAL_RECORDS",
        "limit": "LIMIT",
        "offset": "OFFSET",
        "previous_page": "PREVIOUS_PAGE",
        "next_page": "NEXT_PAGE"
    }
}
AttributeTypeDescription
laboursarrayList of labour records.
labours.statusstringCurrent status of the labour.
labours.uuidstringUnique identifier of the labour.
labours.codestringSystem-generated labour code.
labours.namestringName of the labour.
labours.display_namestringDisplay name of the labour.
labours.descriptionstringDescription of the labour.
labours.image_namestringImage file name associated with the labour.
labours.email_addressstringEmail address of the labour.
labours.use_custom_availabilitybooleanIndicates whether custom availability is enabled.
labours.labour_profileobjectAssociated labour profile details.
labour_profile.statusstringStatus of the labour profile.
labour_profile.uuidstringUnique identifier of the labour profile.
labour_profile.namestringName of the labour profile.
labour_profile.display_namestringDisplay name of the labour profile.
labour_profile.linkstringAPI link to the labour profile.
custom_form_templatestringCustom form template assigned to the labour.
created_bystringUser who created the labour record.
created_onstringTimestamp when the labour was created.
last_updated_bystringUser who last updated the labour record.
last_updated_onstringTimestamp of the last update.
custom_attributesarrayList of custom attributes associated with the labour.
labour_contactsarrayContact details linked to the labour.
labour_custom_availabilityarrayCustom availability schedule entries.
availability.start_timestringStart time of availability window.
availability.end_timestringEnd time of availability window.
availability.availablestringIndicates whether the labour is available.
availability.preferred_daystringPreferred working day.
labour_availabilityarrayDefault availability settings, if configured.
paginationobjectPagination metadata.
pagination.recordsintegerTotal number of records available.
pagination.limitintegerMaximum records returned per page.
pagination.offsetintegerOffset used for pagination.
pagination.previous_pagestringLink or reference to the previous page.
pagination.next_pagestringLink or reference to the next page.

Retrieve Orders by Labour Booking: /labours/{labour_uuid}/orders

GET
https://dev-api.exsited.com/api/v3/labours/{labour_uuid}/orders
Try It Out
Purpose

This API retrieves all orders associated with a specific labour booking. It allows the system to identify which orders a particular labour resource has been booked against, along with detailed order, line item, booking, pricing, and billing information.

Use Case

This endpoint is used in workforce management, scheduling, and billing workflows where administrators or operational systems need to view orders linked to a specific labour booking. Common use cases include validating labour allocations, tracking booked work against orders, auditing labour usage, generating invoices, and reconciling labour-related revenue. It also supports sorting parameters to ensure consistent retrieval of the latest order data across GET APIs.

Path Parameters
AttributeTypeDescription
labour_uuidStringUnique identifier (UUID) of the labour resource whose associated orders are to be retrieved
Query Parameters
AttributeTypeDescription
limitIntegerNumber of records to return per page
offsetIntegerNumber of records to skip for pagination
Request Body

This endpoint does not require a request body

Response

On successful execution, the API returns a paginated list of orders associated with the specified labour booking. Each order includes comprehensive details such as order metadata, account information, billing configuration, custom attributes, line items, booking time ranges, pricing snapshots, tax configurations, and KPI metrics. This response enables downstream systems to fully understand how labour resources are booked, billed, and linked to financial and operational data.

Response Body
JSON
{
  "orders": [
    {
      "status": "ORDER_STATUS",
      "id": "ORDER_ID",
      "pre_order": "BOOLEAN",
      "quote_order": "BOOLEAN",
      "name": "ORDER_NAME",
      "display_name": "ORDER_DISPLAY_NAME",
      "description": "DESCRIPTION",
      "referral_account": "REFERRAL_ACCOUNT",
      "customer_purchase_order_id": "CUSTOMER_PO_ID",
      "shipping_profile": {},
      "shipping_cost": "SHIPPING_COST",
      "discount_profile": null,
      "origin": "ORIGIN",
      "custom_forms": {
        "uuid": "FORM_UUID",
        "name": "FORM_NAME"
      },
      "currency": {
        "uuid": "CURRENCY_UUID",
        "name": "CURRENCY_NAME",
        "link": "CURRENCY_LINK"
      },
      "time_zone": {
        "uuid": "TIMEZONE_UUID",
        "name": "TIMEZONE_NAME",
        "link": "TIMEZONE_LINK"
      },
      "invoice_note": "INVOICE_NOTE",
      "default_warehouse": "WAREHOUSE_NAME",
      "billing_start_date": "BILLING_START_DATE",
      "order_start_date": "ORDER_START_DATE",
      "next_billing_from_date": "NEXT_BILLING_DATE",
      "price_tax_inclusive": "BOOLEAN",
      "billing_address": {},
      "shipping_address": {},
      "created_by": "CREATED_BY",
      "created_on": "CREATED_ON",
      "last_updated_by": "LAST_UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_ON",
      "uuid": "ORDER_UUID",
      "version": "VERSION",
      "account_id": "ACCOUNT_ID",
      "account_name": "ACCOUNT_NAME",
      "allow_contract": "BOOLEAN",
      "custom_attributes": [
        {
          "name": "ATTRIBUTE_NAME",
          "value": "ATTRIBUTE_VALUE"
        }
      ],
      "custom_objects": [],
      "properties": {
        "invoice_mode": "INVOICE_MODE",
        "invoice_term": "INVOICE_TERM",
        "billing_period": "BILLING_PERIOD",
        "payment_mode": "PAYMENT_MODE",
        "payment_term": "PAYMENT_TERM"
      },
      "lines": [
        {
          "charge_item_uuid": "CHARGE_ITEM_UUID",
          "item_uuid": "ITEM_UUID",
          "item_id": "ITEM_ID",
          "item_name": "ITEM_NAME",
          "booking": {
            "labour_uuid": "LABOUR_UUID",
            "booking_start_time": "BOOKING_START_TIME",
            "booking_end_time": "BOOKING_END_TIME"
          },
          "item_order_quantity": "QUANTITY",
          "item_type": "ITEM_TYPE",
          "item_charge_type": "CHARGE_TYPE",
          "total": "TOTAL",
          "subtotal": "SUBTOTAL",
          "tax": "TAX"
        }
      ],
      "total": "ORDER_TOTAL",
      "subtotal": "ORDER_SUBTOTAL",
      "tax": "ORDER_TAX",
      "kpis": {
        "estimated_total": "ESTIMATED_TOTAL",
        "total_revenue": "TOTAL_REVENUE",
        "total_due": "TOTAL_DUE"
      }
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "LIMIT",
    "offset": "OFFSET",
    "previous_page": "PREVIOUS_PAGE_URL",
    "next_page": "NEXT_PAGE_URL"
  }
}
AttributeTypeDescription
ordersArrayList of orders associated with the labour booking
orders.statusStringCurrent status of the order
orders.idStringSystem-generated order identifier
orders.nameStringInternal name of the order
orders.display_nameStringDisplay name of the order
orders.created_onString (ISO 8601)Timestamp when the order was created
orders.account_idStringIdentifier of the account linked to the order
orders.custom_attributesArrayCustom attributes associated with the order
orders.linesArrayLine items included in the order
orders.lines.bookingObjectLabour booking details linked to the order line
orders.lines.booking.labour_uuidStringUUID of the booked labour resource
orders.lines.booking.booking_start_timeString (ISO 8601)Booking start date and time
orders.lines.booking.booking_end_timeString (ISO 8601)Booking end date and time
orders.totalNumberTotal amount for the order
orders.subtotalNumberSubtotal before tax
orders.taxNumberTax amount applied to the order
paginationObjectPagination metadata
pagination.recordsIntegerTotal number of matching records
pagination.limitIntegerNumber of records per page
pagination.offsetIntegerOffset used for pagination
pagination.next_pageStringURL to retrieve the next page of results

Retrieve a Single Labour : /labours/{labour_uuid}

GET
https://dev-api.exsited.com/api/v3/labours/{labour_uuid}
Try It Out
Purpose

This endpoint retrieves the details of a specific labour record identified by its unique UUID. The response includes core labour information such as name, status, email address, and linked labour profile, along with contact details, custom availability schedules, and default availability entries. It is intended for use when a single labour record needs to be loaded in full.

Use Case

This endpoint is used to retrieve a labour record when its details need to be displayed in a workforce management or scheduling interface. It is commonly called to load contact information before assigning a labour to a job or order, or to check custom availability before making a booking. It can also be used to verify the linked labour profile and its associated pricing configuration, or to fetch labour data for display in third-party integrations and calendar systems.

Path Parameters
AttributeTypeDescription
labour_uuidstringThe unique identifier of the labour record to retrieve.
Query Parameters

This endpoint does not require any query parameters.

Request Body

This endpoint does not require a request body.

Response

The API returns a single labour object containing the full details of the requested labour record. This includes identifiers, current status, profile association, contact details with phone, fax, and mobile entries, and availability configuration. If custom availability is enabled for the labour, the response includes a list of day-based availability entries under labour_custom_availability. The labour_availability array contains date-specific availability records. The linked labour profile is returned as a nested object with its own status, identifiers, and a direct API link.

Response Body
JSON
{
  "labour": {
    "status": "LABOUR_STATUS",
    "uuid": "LABOUR_UUID",
    "code": "LABOUR_CODE",
    "name": "LABOUR_NAME",
    "display_name": "LABOUR_DISPLAY_NAME",
    "description": "LABOUR_DESCRIPTION",
    "image_name": "IMAGE_NAME",
    "email_address": "LABOUR_EMAIL",
    "use_custom_availability": "USE_CUSTOM_AVAILABILITY",

    "labour_profile": {
      "status": "PROFILE_STATUS",
      "uuid": "PROFILE_UUID",
      "name": "PROFILE_NAME",
      "display_name": "PROFILE_DISPLAY_NAME",
      "link": "PROFILE_LINK"
    },

    "custom_form_template": "CUSTOM_FORM_TEMPLATE",
    "created_by": "CREATED_BY",
    "created_on": "CREATED_TIMESTAMP",
    "last_updated_by": "LAST_UPDATED_BY",
    "last_updated_on": "LAST_UPDATED_TIMESTAMP",

    "custom_attributes": "CUSTOM_ATTRIBUTES",

    "labour_contacts": [
      {
        "status": "CONTACT_STATUS",
        "uuid": "CONTACT_UUID",
        "contact_type": "CONTACT_TYPE",
        "salutation": "SALUTATION",
        "designation": "DESIGNATION",
        "first_name": "FIRST_NAME",
        "last_name": "LAST_NAME",
        "middle_name": "MIDDLE_NAME",
        "email_address": "CONTACT_EMAIL",
        "receive_email": "RECEIVE_EMAIL",

        "phone": {
          "country_code": "PHONE_COUNTRY_CODE",
          "area_code": "PHONE_AREA_CODE",
          "number": "PHONE_NUMBER",
          "full": "PHONE_FULL",
          "do_not_call": "PHONE_DO_NOT_CALL"
        },

        "fax": {
          "country_code": "FAX_COUNTRY_CODE",
          "area_code": "FAX_AREA_CODE",
          "number": "FAX_NUMBER",
          "full": "FAX_FULL",
          "do_not_call": "FAX_DO_NOT_CALL"
        },

        "mobile": {
          "country_code": "MOBILE_COUNTRY_CODE",
          "area_code": "MOBILE_AREA_CODE",
          "number": "MOBILE_NUMBER",
          "full": "MOBILE_FULL",
          "do_not_call": "MOBILE_DO_NOT_CALL"
        },

        "country": "COUNTRY",
        "state": "STATE",
        "city": "CITY",
        "post_code": "POST_CODE"
      }
    ],

    "labour_custom_availability": [
      {
        "uuid": "CUSTOM_AVAILABILITY_UUID",
        "start_time": "START_TIME",
        "end_time": "END_TIME",
        "available": "AVAILABLE",
        "preferred_day": "PREFERRED_DAY"
      }
    ],

    "labour_availability": [
      {
        "uuid": "AVAILABILITY_UUID",
        "start_time": "START_TIME",
        "end_time": "END_TIME",
        "available": "AVAILABLE",
        "preferred_date": "PREFERRED_DATE"
      }
    ]
  }
}
Attribute
Type
Description
labour
object
The labour record object.
status
string
Current status of the labour (e.g., ACTIVE).
uuid
string
Unique identifier of the labour.
code
string
System-generated labour code (e.g., LABOUR-38123642).
name
string
Name of the labour.
display_name
string
Display name of the labour.
description
string
Description of the labour.
image_name
string
Image file name associated with the labour.
email_address
string
Email address of the labour.
use_custom_availability
boolean
Indicates whether custom availability is enabled.
custom_form_template
string
Custom form template assigned to the labour.
created_by
string
User who created the labour record.
created_on
string
Timestamp when the labour was created (ISO 8601 format).
last_updated_by
string
User who last updated the labour record.
last_updated_on
string
Timestamp of the last update (ISO 8601 format).
custom_attributes
array
List of custom attributes associated with the labour.
labour_profile
object
Associated labour profile details.
status
string
Status of the labour profile.
uuid
string
Unique identifier of the labour profile.
name
string
Name of the labour profile.
display_name
string
Display name of the labour profile.
link
string
API link to the full labour profile resource.
labour_contacts
array
Contact entries linked to the labour.
status
string
Status of the contact.
uuid
string
Unique identifier of the contact.
contact_type
string
Type of the contact (e.g., Contact_1).
salutation
string
Salutation of the contact.
designation
string
Designation or job title of the contact.
first_name
string
First name of the contact.
last_name
string
Last name of the contact.
middle_name
string
Middle name of the contact.
email_address
string
Email address of the contact.
receive_email
string
Indicates whether the contact receives email notifications.
phone
object
Phone number details of the contact.
country_code
string
Country dialing code (e.g., +61).
area_code
string
Area code.
number
string
Phone number.
full
string
Full formatted phone number.
do_not_call
string
Indicates whether the contact has a do-not-call flag set.
fax
object
Fax number details. Same structure as phone.
mobile
object
Mobile number details. Same structure as phone.
country
string
Country code of the contact address (e.g., AU).
state
string
State of the contact address.
city
string
City of the contact address.
post_code
string
Post code of the contact address.
labour_custom_availability
array
Custom availability schedule entries, present when use_custom_availability is true.
uuid
string
Unique identifier of the custom availability entry.
start_time
string
Start time of the availability window (HH:mm format).
end_time
string
End time of the availability window (HH:mm format).
available
string
Indicates whether the labour is available on this day.
preferred_day
string
Day of the week for this availability entry (e.g., monday).
labour_availability
array
Date-specific availability entries from the linked labour profile.
uuid
string
Unique identifier of the availability entry.
start_time
string
Start time of the availability window (HH:mm format).
end_time
string
End time of the availability window (HH:mm format).
available
string
Indicates whether the labour is available on this date.
preferred_date
string
The specific date for this availability entry (YYYY-MM-DD format).

Retrieve Available Labours for Booking : /labours/available-for-booking

GET
https://dev-api.exsited.com/api/v3/labours/available-for-booking
Try It Out
Purpose

This endpoint retrieves a list of labour records that are available within a specified date and time range. It checks each labour's availability schedule either from their custom availability settings or from the linked labour profile  and returns only those who are free during the requested window. An optional profile filter can be applied to limit results to labours assigned to a specific labour profile.

Use Case

This endpoint is used when a booking needs to be created and the system must determine which labours are free during a given time period. It is called before assigning a labour to a job or order, to avoid scheduling conflicts. It can also be used to populate a staff selection list where only available labours are shown to the user. The profile parameter is useful when results need to be limited to labours that belong to a particular labour profile.

Path Parameters

This endpoint does not use any path parameters.

Query Parameters
AttributeTypeDescription
start_datestringThe start of the booking window (YYYY-MM-DD HH:mm format).
end_datestringThe end of the booking window (YYYY-MM-DD HH:mm format).
profilestringThe UUID of the labour profile to filter results by. Only labours linked to this profile are returned.
Request Body

This endpoint does not require a request body.

Response

The API returns a labours array containing each labour record that is available within the specified time range. Each object includes the labour's identifiers, current status, email address, and a flag indicating whether custom availability is enabled. The linked labour profile is returned as a nested object with its own identifiers and a direct API link. If use_custom_availability is true, the labour_custom_availability array contains day-based schedule entries for that labour. The labour_availability array contains date-specific availability records from the labour profile. Only labours with no scheduling conflict during the requested window are included in the response.

Response Body

JSON
{
  "labours": [
    {
      "status": "LABOUR_STATUS",
      "uuid": "LABOUR_UUID",
      "code": "LABOUR_CODE",
      "name": "LABOUR_NAME",
      "display_name": "LABOUR_DISPLAY_NAME",
      "description": "LABOUR_DESCRIPTION",
      "image_name": "IMAGE_NAME",
      "email_address": "LABOUR_EMAIL",
      "use_custom_availability": "USE_CUSTOM_AVAILABILITY",

      "labour_profile": {
        "status": "PROFILE_STATUS",
        "uuid": "PROFILE_UUID",
        "name": "PROFILE_NAME",
        "display_name": "PROFILE_DISPLAY_NAME",
        "link": "PROFILE_LINK"
      },

      "custom_form_template": "CUSTOM_FORM_TEMPLATE",
      "created_by": "CREATED_BY",
      "created_on": "CREATED_TIMESTAMP",
      "last_updated_by": "LAST_UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_TIMESTAMP",
      "custom_attributes": "CUSTOM_ATTRIBUTES",
      "labour_custom_availability": "LABOUR_CUSTOM_AVAILABILITY",
      "labour_availability": "LABOUR_AVAILABILITY"
    },

    {
      "status": "LABOUR_STATUS",
      "uuid": "LABOUR_UUID",
      "code": "LABOUR_CODE",
      "name": "LABOUR_NAME",
      "display_name": "LABOUR_DISPLAY_NAME",
      "description": "LABOUR_DESCRIPTION",
      "image_name": "IMAGE_NAME",
      "email_address": "LABOUR_EMAIL",
      "use_custom_availability": "USE_CUSTOM_AVAILABILITY",

      "labour_profile": {
        "status": "PROFILE_STATUS",
        "uuid": "PROFILE_UUID",
        "name": "PROFILE_NAME",
        "display_name": "PROFILE_DISPLAY_NAME",
        "link": "PROFILE_LINK"
      },

      "custom_form_template": "CUSTOM_FORM_TEMPLATE",
      "created_by": "CREATED_BY",
      "created_on": "CREATED_TIMESTAMP",
      "last_updated_by": "LAST_UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_TIMESTAMP",
      "custom_attributes": "CUSTOM_ATTRIBUTES",

      "labour_custom_availability": [
        {
          "uuid": "CUSTOM_AVAILABILITY_UUID",
          "start_time": "START_TIME",
          "end_time": "END_TIME",
          "available": "AVAILABLE",
          "preferred_day": "PREFERRED_DAY"
        }
      ],

      "labour_availability": [
        {
          "uuid": "AVAILABILITY_UUID",
          "start_time": "START_TIME",
          "end_time": "END_TIME",
          "available": "AVAILABLE",
          "preferred_date": "PREFERRED_DATE"
        }
      ]
    },

    {
      "status": "LABOUR_STATUS",
      "uuid": "LABOUR_UUID",
      "code": "LABOUR_CODE",
      "name": "LABOUR_NAME",
      "display_name": "LABOUR_DISPLAY_NAME",
      "description": "LABOUR_DESCRIPTION",
      "image_name": "IMAGE_NAME",
      "email_address": "LABOUR_EMAIL",
      "use_custom_availability": "USE_CUSTOM_AVAILABILITY",

      "labour_profile": {
        "status": "PROFILE_STATUS",
        "uuid": "PROFILE_UUID",
        "name": "PROFILE_NAME",
        "display_name": "PROFILE_DISPLAY_NAME",
        "link": "PROFILE_LINK"
      },

      "custom_form_template": "CUSTOM_FORM_TEMPLATE",
      "created_by": "CREATED_BY",
      "created_on": "CREATED_TIMESTAMP",
      "last_updated_by": "LAST_UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_TIMESTAMP",
      "custom_attributes": "CUSTOM_ATTRIBUTES",

      "labour_custom_availability": [
        {
          "uuid": "CUSTOM_AVAILABILITY_UUID",
          "start_time": "START_TIME",
          "end_time": "END_TIME",
          "available": "AVAILABLE",
          "preferred_day": "PREFERRED_DAY"
        }
      ],

      "labour_availability": [
        {
          "uuid": "AVAILABILITY_UUID",
          "start_time": "START_TIME",
          "end_time": "END_TIME",
          "available": "AVAILABLE",
          "preferred_date": "PREFERRED_DATE"
        }
      ]
    }
  ]
}
AttributeTypeDescription
laboursarrayList of available labour record objects.
statusstringCurrent status of the labour (e.g., ACTIVE).
uuidstringUnique identifier of the labour.
codestringSystem-generated labour code (e.g., LABOUR-23061622).
namestringName of the labour.
display_namestringDisplay name of the labour.
descriptionstringDescription of the labour.
image_namestringImage file name associated with the labour.
email_addressstringEmail address of the labour.
use_custom_availabilitybooleanIndicates whether custom availability is enabled for the labour.
custom_form_templatestringCustom form template assigned to the labour.
created_bystringUser who created the labour record.
created_onstringTimestamp when the labour was created (ISO 8601 format).
last_updated_bystringUser who last updated the labour record.
last_updated_onstringTimestamp of the last update (ISO 8601 format).
custom_attributesarrayList of custom attributes associated with the labour.
labour_profileobjectAssociated labour profile details.
labour_profile.statusstringStatus of the labour profile.
labour_profile.uuidstringUnique identifier of the labour profile.
labour_profile.namestringName of the labour profile.
labour_profile.display_namestringDisplay name of the labour profile.
labour_profile.linkstringAPI link to the full labour profile resource.
labour_custom_availabilityarrayCustom availability schedule entries, present when use_custom_availability is true.
labour_custom_availability.uuidstringUnique identifier of the custom availability entry.
labour_custom_availability.start_timestringStart time of the availability window (HH:mm format).
labour_custom_availability.end_timestringEnd time of the availability window (HH:mm format).
labour_custom_availability.availablestringIndicates whether the labour is available on this day.
labour_custom_availability.preferred_daystringDay of the week for this availability entry (e.g., monday).
labour_availabilityarrayDate-specific availability entries from the linked labour profile.
labour_availability.uuidstringUnique identifier of the availability entry.
labour_availability.start_timestringStart time of the availability window (HH:mm format).
labour_availability.end_timestringEnd time of the availability window (HH:mm format).
labour_availability.availablestringIndicates whether the labour is available on this date.
labour_availability.preferred_datestringThe specific date for this availability entry (YYYY-MM-DD format).

Looking to build your next big project?

With our robust set of tools and resources, you can create custom solutions that integrate seamlessly with our system and take your business to the next level.

Join Our Partner Program
APIs
SDK
Help Center
Community
Contact Us

©2026 Exsited. All rights reserved.

Terms and Conditions | Privacy Policy

Follow Us: