The Customer Object

A customer (also called a "job") represents a client or account that employees can track time against. Customers are used for job costing — allocating hours and payroll costs to specific clients.

Variants

Shape	Returned by	Extra fields
List item	`GET /customers`	—
Detail	`GET /customers/:customer_id`	`projects`

The detail shape is a superset of the list shape.

Field Reference

Field	Type	Description
`customer_id`	integer	Unique customer identifier.
`name`	string	Customer name.
`is_disabled`	boolean	Whether the customer is disabled. Disabled customers cannot be assigned to new time records.
`projects`	array	(Detail only) List of project summaries under this customer.

Project summary (nested in detail)

Field	Type	Description
`project_id`	integer	Unique project identifier.
`name`	string	Project name.
`is_disabled`	boolean	Whether the project is disabled.

Example: List Item

{
  "customer_id": 3,
  "name": "ABC Construction",
  "is_disabled": false
}

Example: Detail

{
  "customer_id": 3,
  "name": "ABC Construction",
  "is_disabled": false,
  "projects": [
    {
      "project_id": 7,
      "name": "Office Renovation",
      "is_disabled": false
    },
    {
      "project_id": 12,
      "name": "Warehouse Build",
      "is_disabled": true
    }
  ]
}

The Project Object

A project belongs to a customer and provides a second level of granularity for time tracking and job costing. Employees can clock in to a specific customer and project.

Returned by

Endpoint	Shape
`GET /projects`	List of projects
`GET /projects/:project_id`	Single project

Field Reference

Field	Type	Description
`project_id`	integer	Unique project identifier.
`name`	string	Project name.
`customer_id`	integer \| null	The customer this project belongs to. Null if unassigned.
`is_disabled`	boolean	Whether the project is disabled. Disabled projects cannot be assigned to new time records.
`customer`	object \| null	The parent customer summary with `customer_id` and `name`. Null if no customer is assigned.

Customer summary (nested)

Field	Type	Description
`customer_id`	integer	Unique customer identifier.
`name`	string	Customer name.

Example

{
  "project_id": 7,
  "name": "Office Renovation",
  "customer_id": 3,
  "is_disabled": false,
  "customer": {
    "customer_id": 3,
    "name": "ABC Construction"
  }
}