Overview

Generate Access Token

Exchange your client and user credentials for an access token. Use the returned `access_token` as a Bearer token in the `Authorization` header when calling the Client API.

List Work Orders

Retrieve a paginated list of work orders for your company. Use the extensive query filters (status, dates, location, pay, template, etc.) and `page`/`per_page` to control pagination. Use `columns`/`view` to adjust which fields are returned.

Create Work Order

Create a new work order. Provide the essential details for the job; the response returns the newly created work order with identifiers.

List Work Order Lists

Return saved work order lists (e.g., tabs or saved searches) and their current counts, honoring the `list` and sticky parameters.

Get Work Order Details

Get full details for a specific work order. Use `columns` to control which sections are included in the response.

Delete Work Order

Cancel and delete a work order. A `cancel_reason` is required to document the reason for deletion.

Update Work Order

Update an existing work order. Only the provided fields will be updated.

Publish a Work Order

Move a draft work order to a published state so it becomes available for routing and assignment. Use `async=true` to process asynchronously.

Unpublish a Work Order

Unpublish a previously published work order, returning it to draft. Use `async=true` to process asynchronously.

Approve a Work Order

Approve a work order after the work is completed and verified.

Revert work order to draft status

Revert a work order back to draft. Use `async=true` for asynchronous processing.

Mass route a work order to providers

Route a work order to multiple providers in a single request. Submit the list of provider IDs in the request body.

Route a work order to a user

Route a work order to a single provider (user). Use `acting_user_id` when routing on behalf of another user, and `async=true` for async mode.

Un-route a work order from an user

Remove a previously routed provider (user) from a work order. Supports asynchronous processing via `async=true`.

Assign user by work order

Assign a provider (user) directly to a work order. Optionally include `clientPayTermsAccepted` to record acceptance of pay terms.

Unassign user from a work order

Remove the assigned provider (user) from a work order.

Incomplete a Work Order

Mark a completed work order as incomplete. A `reason` and `reason_id` are required to document the change.

Get work order pay

Get the full pay breakdown for a work order, including base, additional, fees, bonuses, expenses, penalties and totals.

Update Work Order Pay

Update the pay configuration for a work order. Only provided fields are changed.

Get Work Order Schedule

Retrieve the service window and scheduling information for a work order.

Update Work Order Schedule

Update the service window and scheduling information for a work order.

Get Work Order ETA

Get the estimated time of arrival (ETA) and related timing information for this work order.

Get Work Order Location

Retrieve the current location for a work order, including saved location details when applicable.

Update Work Order Location

Update the location associated with the work order (address, saved location, or coordinates).

Get Work Order Status

Return the current status of a work order (including sub-status and flags).

List Work Order Discounts

List any discounts applied to the work order.

List Work Order Increases

List pay increases applied to the work order.

Get Work Order Increase

Retrieve details for a specific pay increase on this work order.

Update Work Order Pay Increase

Update a specific pay increase entry for the work order.

List Work Order Signatures

List signatures captured for the work order with metadata and authorship.

Create Work Order Signature

Add a signature to the work order. Include the image data and metadata in the JSON payload.

Get Work Order Signature

Retrieve a single signature by its ID for the given work order.

Delete Work Order Signature

Delete a signature from the work order by its ID.

List Work Order Time Logs

List all time logs recorded against the work order, including check-in/out and verification details.

Create Work Order Time Log

Add a new time log (check-in or check-out) for the work order.

Update All Work Order Time Logs

Bulk update time logs for a work order in a single request.

Delete Work Order Time Log

Delete a single time log entry from the work order.

Update Work Order Time Log

Update a single time log entry for the work order.

List Work Order Qualifications

List the qualification rules and outcomes for the work order.

Create Work Order Qualification

Add or update qualification requirements for a work order.

Update Work Order Qualification

Update Work Order Qualification

Delete Work Order Qualification

Delete Work Order Qualification

List Work Order Messages

Retrieve all messages for a work order. Use the `archived` filter to include or exclude archived messages.

Create Work Order Message

Post a new message to a work order. Optionally set `async=true` to process the delivery asynchronously.

Reply to Work Order Message

Reply to an existing work order message by its `message_id`. Supports asynchronous processing via `async=true`.

List Work Order Attachments

List attachment folders and files associated with the work order.

Create Attachment Folder

Create a new attachment folder to organize files for the work order.

Create Work Order Attachment

Upload a file to the specified attachment folder using `multipart/form-data`.

Delete Attachment Folder

Delete an attachment file from the specified folder.

Update Work Order Attachment

Update attachment metadata (for example, visibility or notes) within the specified folder.

List Work Order Contacts

List contacts associated with the work order.

Create Work Order Contact

Add a new contact to the work order.

Delete Work Order Contact

Remove a contact from the work order by `contact_id`.

Update Work Order Contact

Update a contact for the work order by `contact_id`.

List Work Order Expenses

List recorded expenses for the work order along with metadata and statuses.

Create Work Order Expense

Create a new expense entry for the work order.

Update Work Order Expense

Update an existing expense entry for the work order.

List Work Order Bonuses

List bonus entries that have been applied or are available for the work order.

Create Work Order Bonus

Create or apply a bonus by `bonus_id` to the work order.

List Work Order Penalties

List penalty entries associated with the work order.

Create Work Order Penalty

Create or apply a penalty by `penalty_id` to the work order.

List Work Order Custom Fields

List custom fields configured for this work order, including values and visibility.

Get Work Order Custom Field

Retrieve a single custom field configuration/value by `custom_field_id`.

Update Work Order Custom Field

Update a custom field value/configuration for the work order.

List Work Order Tasks

List tasks defined for the work order with current status and metadata.

Create Work Order Task

Create a new task within the work order.

Update Work Order Tasks

Bulk update multiple tasks for a work order in a single request.

Get Work Order Task

Retrieve the details for a single task by `task_id`.

Delete Work Order Task

Remove a task from the work order by `task_id`.

Update Work Order Task

Update the details for a single task by `task_id`.

Delete Work Order Task Alerts

Clear all alerts for the specified task.

Delete Work Order Task Alert

Delete a single alert for the specified task by `alert_id`.

List Work Order Shipments

List shipments related to the work order, including direction, carrier and status.

Create Work Order Shipment

Create a shipment record for the work order (incoming or outgoing).

Delete Work Order Shipment

Remove a shipment entry from the work order by `shipment_id`.

Update Work Order Shipment

Update a shipment entry for the work order by `shipment_id`.

List Work Order Tags

List tags assigned to the work order.

Create Work Order Tag

Add a tag to the work order.

Delete Work Order Tag

Remove a tag from the work order by `tag_id`.

List Work Order Problems

List reported problems for the work order, including types and statuses.

Create Work Order Problem

Report a new problem for the work order.

Delete Work Order Problem

Delete a problem record by `problem_id`.

Update Work Order Problem

Update an existing problem record by `problem_id`.

Unassign Work Order Provider

Unassign and remove the currently assigned provider from the work order.

Acknowledge Provider Delay

Acknowledge a provider-reported delay on the work order.

List Work Order Pending Requests

List pending provider requests (e.g., route requests) for the work order.

List Work Order Milestones

List key lifecycle timestamps for the work order (created, published, routed, assigned, work done, approved, paid).

Validate Work Order Bundle

Validate that a list of work orders can be bundled together. Returns validation diagnostics without making changes.

Bundle Work Order

Create a bundle that groups multiple work orders together for unified management and routing.

Unbundle Work Order

Remove work orders from a previously created bundle.

Delete Work Order Bundle

Delete the bundle associated with the specified work order.

Delete Work Order Incident ID

Remove the incident ID from the work order.

Update Work Order Incident

Update incident ID associated with the work order.

Update Work Order Job Status

Update the job status of a work order (e.g., scope of work complete or incomplete).

List Work Order Site Revisits

List site revisit entries for a work order, including counts and latest revisit details.

Create Work Order Site Revisit

Create a site revisit record for the work order.

Delete Work Order Site Revisit

Delete a site revisit entry by `revisit_id`.

Update Work Order Site Revisit

Update a site revisit entry by `revisit_id`.

Auto-Dispatch Work Order

Automatically dispatch a work order to a qualified provider based on configured dispatch rules.

Get workorder templates

Retrieve available work order templates that can be used to quickly create work orders with predefined fields and tasks.

Get workorder template by id

Retrieve a single work order template by `template_id`, including its tasks and configuration.

Get types of work

Retrieve all available types of work and their associated service categories.

Get projects

Retrieve a paginated list of projects for your company with optional filters and column selection.

Create project

Create a new project for your company, including core details and configuration for organizing work orders.

Get project by ID

Retrieve the full details for a single project identified by `project_id`.

Add multiple providers to project talent pool groups

This endpoint allows you to add one or more providers to multiple talent pool groups with specific tier (talent pool) assignments. Each talent pool group can have multiple tier assignments, and the providers will be added to the specified tier within each talent pool group.

Get Provider Talent Pool Group Assignments in Project

This endpoint retrieves all talent pool groups and their tiers that a provider is assigned to within a specific project

Update Provider Talent Pool Group Assignments in Project

This endpoint updates a provider's talent pool group and tier assignments for a specific project. It removes old tier assignments and adds new ones based on the provided data. The provider ID itself cannot be changed.

List Service Types

Retrieve all service types associated with a specific type of work.

List Company Tags

Retrieve all tags associated with your company.

Create Company Tag

Create a new tag for your company.

List Company Expenses

Retrieve all expense categories configured for your company.

List Company Networks

Retrieve all networks accessible by the specified company.

List Company Managers

Retrieve all managers associated with your company.

List Site Revisit Reasons

Retrieve available reasons that providers and your company can select when entering revisit and job incomplete details.

List Incomplete Reasons

Retrieve all incomplete reason options configured for your company.

List Custom Fields

Retrieve all custom fields available for work orders.

List Bonuses

Retrieve all bonus options available for work orders.

List Penalties

Retrieve all penalty options available for work orders.

Get User Details

Retrieve detailed information about a specific user by their ID.

List Talent Pool Groups

Retrieve all talent pool groups (preferred provider groups) available to your company.

Get Talent Pool Group Details

Retrieve detailed information about a specific talent pool group by its ID.

Add Provider to Talent Pool Group

Add a provider to a specific talent pool group.

List Talent Pool Group Users

Retrieve all providers (users) in a specific talent pool group.

Remove Providers from Talent Pool Group

Remove one or more providers from a talent pool group.

List Provider IDs by Group

Retrieve all provider IDs associated with a specific preferred provider group.

List Talent Pool Groups

Retrieve a paginated list of talent pool groups with optional filtering and sorting.

Create Talent Pool Group

Create a new talent pool group with associated talent pools.

Get Talent Pool Group Details

Retrieve detailed information about a specific talent pool group by its UUID.

Delete Talent Pool Group

Delete a specific talent pool group and all its associated data.

Update Talent Pool Group

Update a specific talent pool group and its associated talent pools.

List Providers in Talent Pool Group

Retrieve a paginated list of providers in a specific talent pool group with optional sorting.

Remove Provider from Talent Pool Group

Remove a provider from a talent pool group. Either `tierId` or `removeFromProject` query parameter is required. If `tierId` is provided, removes the provider from the specified talent pool (tier) within the group. If `removeFromProject` is true, removes the provider from all talent pool groups in the project.

List Provider Attributes

Retrieve a paginated list of attributes for a specific provider in a talent pool with optional sorting.

Create Provider Attributes

Add new attributes for a specific provider in a talent pool.

Update Provider Attributes

Bulk update multiple attributes for a specific provider in a talent pool.

Delete Provider Attribute

Delete a specific attribute for a provider in a talent pool.

Update Provider Attribute

Update the value of a specific attribute for a provider in a talent pool.

List Clients

Retrieve a paginated list of client companies with optional filters, lists, and column selection.

Create Client

Creates a new client for your company

Get Client

Retrieve details for a single client company identified by `client_id`.

List Locations

Gets stored locations

Create Location

Add a location to company

Get Location

Retrieve details for a single saved location identified by `location_id`.

Trigger Smart Dispatch

This endpoint allows you to trigger smart dispatch process for one or more workorders.

List Service Territories

Get a paginated list of service territories

Create Service Territory

Create a new service territory

Get Service Territory

Get a specific service territory by its ID

Delete service territory

Delete a specific service territory by its ID

Update service territory

Update a specific service territory and its associated talent pools

Get providers in a service territory

Get a paginated list of providers in a specific service territory

Remove provider from service territory

Removes a provider from a service territory. Either tierId or removeFromProject query parameter is required. If tierId is provided: Removes the provider from the specified talent pool within the group. If removeFromProject is true: Removes the provider from all service territories in the project.

Create Dispatch Settings

This endpoint allows you to create smart dispatch settings for a project.

Get Dispatch Settings

Get Dispatch Settings

Update Dispatch Settings

This endpoint allows you to update smart dispatch settings for a project.