Work Types

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Query Work Types

Retrieve all work types configured for the company. Work types represent special pay conditions or rules that can be applied to timesheets (e.g., minimum break requirements, overtime, public holiday rates).

Query Parameters:

This query takes no parameters and returns all work types configured for the company.

Response Fields:

Field	Description
`id`	Unique identifier for the work type
`name`	Name of the work type (e.g., "PH - Standard - Standard", "Min Break")
`appliedFromId`	ID of the rule or template this work type was applied from (if applicable)

For the complete WorkType type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

Work types are used to apply special pay conditions to timesheets
They are typically generated from pay rule configurations
Common work type patterns include "PH" (Public Holiday), "Min Break", "Overtime"
Work types are company-specific and all accessible work types are returned in a single query

GraphQL Query

query WorkTypes {
  workTypes {
    id
    name
    appliedFromId
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "workTypes": [
      {
        "id": "49",
        "name": "PH - Standard - Standard",
        "appliedFromId": null
      },
      {
        "id": "114",
        "name": "Min Break",
        "appliedFromId": null
      }
    ]
  }
}