Lists, dates and money

The same few rules hold across the whole API.

Lists

A list answers with every record that matches, in one go. Narrow it with the query parameters each list offers: usually a date range (from and to), a status, a client or project, or q to search by words.

curl "https://app.workscope.co.uk/v1/bookings?from=2026-11-01&to=2026-11-30&clientId=3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41" \
  -H "Authorization: Bearer wsk_your_key_here"

Date ranges include both ends. Long lists are capped (bookings at 2,000 a request, clients at 1,000), so for bookings and timesheets ask for a month or so at a time.

Dates and times

Days and times of day are the company's own local time, set in Settings (Europe/London unless changed). A booking on 2026-11-06 at 09:00 means 9am that day where the work is, summer time or not.

Moments, such as when something was made (createdAt) or when someone clocked in, are exact points in time in UTC. Turn them into local time for display.

Money

Amounts are whole numbers of pence, in fields whose names end in Pence. 4500 is £45.00. There are no decimals to round.

Lengths of time

Lengths are whole minutes in fields ending in Minutes (durationMinutes: 90 is an hour and a half). Holiday balances use seconds, in fields ending in Seconds, so part-hours add up exactly.

Ids

Every record has an id, a UUID such as 3f2a9c1e-6b4d-4e8a-9f1c-2d7b5a0e8c41. Ids never change, so keep them to match records with your own system.

Your own words

A company can rename things in Workscope: "projects" might be "sites" or "properties", "bookings" might be "visits". The API always uses the standard names (clients, projects, jobs, bookings, team members), whatever the company calls them.

Custom fields

Fields a company adds itself come in customFields, an object keyed by each field's short name (its slug). GET /v1/custom-fields lists them with their labels and kinds.