Skip to main content

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.

Plan feature

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​

GET/v1/projects

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
statusactive · archivedNoOnly projects in this state.

Responses​

StatusMeaning
200A page of projects.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Timesheets (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve a project​

GET/v1/projects/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The project.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Timesheets (plan_upgrade_required).
403The key does not carry the required scopes.
404No such project in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.

List timesheets​

GET/v1/timesheets

Query parameters​

NameTypeRequiredDescription
limitintegerNoPage size. Values above 100 are clamped.
starting_afterstringNoOpaque cursor from a previous response’s next_cursor.
updated_sincetimestampNoReturn records changed at or after this instant. Tracks the record itself, not its child collections.
statusdraft · submitted · approved · rejectedNoOnly timesheets in this state.
employee_idstringNoOne employee’s timesheets.
week_start_fromdateNoWeeks starting on or after this day.
week_start_todateNoWeeks starting on or before this day.

Responses​

StatusMeaning
200A page of timesheets.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Timesheets (plan_upgrade_required).
403The key does not carry the required scopes.
429Rate limit exceeded. See the RateLimit-* headers.

Retrieve a timesheet​

GET/v1/timesheets/{id}

Path parameters​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The timesheet.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Timesheets (plan_upgrade_required).
403The key does not carry the required scopes.
404No such timesheet in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.

List the entries of a timesheet​

GET/v1/timesheets/{id}/entries

Every 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​

NameTypeRequiredDescription
idstringYesThe identifier returned as id on the object.

Responses​

StatusMeaning
200The entries.
401The API key is missing, malformed, revoked or expired.
402The workspace's plan does not include Timesheets (plan_upgrade_required).
403The key does not carry the required scopes.
404No such timesheet in this workspace.
429Rate limit exceeded. See the RateLimit-* headers.