timesheets

List Timesheets

Retrieve a paginated list of timesheets (time entries).

Supports:

  • Pagination (page_size, page)
  • Sorting by last updated (order_by, default: desc)
  • Filter by project_id / account_id / opportunity_id (aliases — projects, accounts, and opportunities share the same underlying record), work_order_id, user_id, and type
  • Filter by the entry's own date range (start_date, end_date) or by last-updated time (updated_after, updated_before)

Archived timesheets are excluded unless include_archived=true is passed.

get/timesheets

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/timesheets
  • Auth: API key in header x-api-key

Query parameters

page_sizeinteger

Number of items per page (max 100)

pageinteger

Page number (1-based)

order_by'asc' | 'desc'

Sort order for results

project_idinteger

Filter by project ID. Alias of account_id/opportunity_id.

account_idinteger

Filter by account ID. Alias of project_id/opportunity_id.

opportunity_idinteger

Filter by opportunity ID. Alias of project_id/account_id.

work_order_idinteger

Filter by work order ID.

user_idinteger

Filter by the worker the time entry is logged for.

type'WORKING' | 'TRAVEL'

Filter by time entry type.

status'PROCESSING' | 'PROCESSED' | 'FAILED'

Filter by processing status.

include_archivedboolean

Include archived timesheets in the results.

start_datestring date-time

Only return timesheets whose start time is at or after this timestamp.

end_datestring date-time

Only return timesheets whose end time is at or before this timestamp.

string date
OR
string date-time

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

string date
OR
string date-time

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

Response

List of timesheets

idinteger

Unique identifier.

type'WORKING' | 'TRAVEL'

Time entry type.

status'PROCESSING' | 'PROCESSED' | 'FAILED'

Processing status of the time entry.

startDatestring date-time nullable
endDatestring date-time nullable
distancenumber double nullable

Distance traveled, for TRAVEL entries.

notestring nullable
isArchivedboolean nullable
createdAtstring date-time
updatedAtstring date-time
projectIdinteger nullable

Set when the linked record is a Project. Null when it is an Account (see accountId) or Opportunity (see opportunityId).

accountIdinteger nullable

Set when the linked record is an Account. Null otherwise.

opportunityIdinteger nullable

Set when the linked record is an Opportunity. Null otherwise.

workOrderIdinteger nullable
targetUserIdinteger nullable

The worker the time entry is logged for.

createdByinteger nullable
updatedByinteger nullable
laborHourlyRatenumber double nullable

Labor cost ($/hr). Only visible with the appropriate financial privilege.

laborTotalCostnumber double nullable

Only visible with the appropriate financial privilege.

Changes

No recorded changes to this operation across all 1 revision of this API.