Timesheets
The projects hours are logged against and each employee’s weekly timesheet: its status (draft, submitted, approved or rejected), the total hours and, through the entries route, every line with its project, task, day and hours. A timesheet is filled in and submitted on the portal and decided through the approval flow; timesheet.submitted, timesheet.approved and timesheet.rejected announce the moves.
Available on plans that include timesheets.
These endpoints need a plan that includes Timesheets (timesheets). On a plan without it, requests return 402 with code: plan_upgrade_required and feature naming what an upgrade would add.
List projects
/v1/projectsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
status | active · archived | No | Only projects in this state. |
Responses
| Status | Meaning |
|---|---|
200 | A page of projects. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Timesheets (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve a project
/v1/projects/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The project. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Timesheets (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such project in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
List timesheets
/v1/timesheetsQuery parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size. Values above 100 are clamped. |
starting_after | string | No | Opaque cursor from a previous response’s next_cursor. |
updated_since | timestamp | No | Return records changed at or after this instant. Tracks the record itself, not its child collections. |
status | draft · submitted · approved · rejected | No | Only timesheets in this state. |
employee_id | string | No | One employee’s timesheets. |
week_start_from | date | No | Weeks starting on or after this day. |
week_start_to | date | No | Weeks starting on or before this day. |
Responses
| Status | Meaning |
|---|---|
200 | A page of timesheets. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Timesheets (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
Retrieve a timesheet
/v1/timesheets/{id}Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The timesheet. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Timesheets (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such timesheet in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |
List the entries of a timesheet
/v1/timesheets/{id}/entriesEvery line of the week in date order: project_id, task_id (null for hours on the project itself), date, hours as a decimal string in quarter hours, and note. The list is the whole week, never paged.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The identifier returned as id on the object. |
Responses
| Status | Meaning |
|---|---|
200 | The entries. |
401 | The API key is missing, malformed, revoked or expired. |
402 | The workspace's plan does not include Timesheets (plan_upgrade_required). |
403 | The key does not carry the required scopes. |
404 | No such timesheet in this workspace. |
429 | Rate limit exceeded. See the RateLimit-* headers. |