List Timesheets | Coperniq API

const url = 'https://api.coperniq.io/v1/timesheets';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "type": "WORKING",
    "status": "PROCESSING",
    "startDate": "2024-01-15T09:30:00Z",
    "endDate": "2024-01-15T09:30:00Z",
    "distance": 1.1,
    "note": "string",
    "isArchived": true,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "projectId": 1,
    "accountId": 1,
    "opportunityId": 1,
    "workOrderId": 1,
    "targetUserId": 1,
    "createdBy": 1,
    "updatedBy": 1,
    "laborHourlyRate": 1.1,
    "laborTotalCost": 1.1
  }
]

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.

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.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

order_byenumOptionalDefaults to asc

Sort order for results

Allowed values:

project_idintegerOptional

Filter by project ID. Alias of account_id/opportunity_id.

account_idintegerOptional

Filter by account ID. Alias of project_id/opportunity_id.

opportunity_idintegerOptional

Filter by opportunity ID. Alias of project_id/account_id.

work_order_idintegerOptional

Filter by work order ID.

user_idintegerOptional

Filter by the worker the time entry is logged for.

typeenumOptional

Filter by time entry type.

Allowed values:

statusenumOptional

Filter by processing status.

Allowed values:

include_archivedbooleanOptionalDefaults to false

Include archived timesheets in the results.

start_datestringOptionalformat: "date-time"

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

end_datestringOptionalformat: "date-time"

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

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

Response

List of timesheets

idinteger

Unique identifier.

typeenum or null

Time entry type.

statusenum or null

Processing status of the time entry.

startDatestring or nullformat: "date-time"

endDatestring or nullformat: "date-time"

distancedouble or null

Distance traveled, for TRAVEL entries.

notestring or null

isArchivedboolean or null

createdAtstringformat: "date-time"

updatedAtstringformat: "date-time"

projectIdinteger or null

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

accountIdinteger or null

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

opportunityIdinteger or null

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

workOrderIdinteger or null

targetUserIdinteger or null

The worker the time entry is logged for.

createdByinteger or null

updatedByinteger or null

laborHourlyRatedouble or null

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

laborTotalCostdouble or null

Only visible with the appropriate financial privilege.

Errors

400

Bad Request Error

401

Unauthorized Error

502

Bad Gateway Error