api.hirepos.com/Tasks

Edited

The Tasks endpoint allows third-party applications and integrations to create tasks in HirePOS.

Tasks can include a description, start date and time, duration, assigned staff member, task type and notes. They can also be linked to an existing HirePOS Invoice, Customer or Lead.

Usage

The endpoint supports different request methods depending on the required action:

  • GET – Retrieve task information from HirePOS.

  • POST – Create a new task in HirePOS.

When creating a task, include the required task details and any applicable Invoice, Customer or Lead references in the request.

Example

POST https://api.hirepos.com/Tasks

Headers:
AuthKey={YourAPIKey}
AuthSecret={YourAPISecret}

Parameters:
POST


// Example Request...

{
    "TaskDescription": "Deliver equipment to site",
    "TaskStartDateTime": "2026-07-20T09:00:00",
    "TaskDurationMinutes": 60,
    "StaffCode": "GS",
    "TaskType": "Delivery",
    "TaskNotes": "Contact the site manager on arrival.",
    "InvoiceNo": 1008,
    "CustomerCode": "1000",
    "LeadCode": ""
}


// Example Response...

{
    "ErrorRaised": "False",
    "ErrorType": null,
    "ErrorMessage": null,
    "Tasks": [
        {
            "Id": 59,
            "TaskDescription": "Deliver equipment to site",
            "TaskStartDateTime": "2026-07-20T09:00:00",
            "TaskDurationMinutes": 60,
            "StaffCode": "GS",
            "TaskType": "Delivery",
            "TaskNotes": "Contact the site manager on arrival.",
            "InvoiceNo": 1008,
            "CustomerCode": "1000",
            "LeadCode": null
        }
    ]
}

Conclusion

The Task endpoint in hirepos provides a convenient way to retrieve and post Tasks to HirePOS. Tasks can be retrieved using GET or created using POST, with support for assigning staff and linking tasks to relevant HirePOS records.

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.