agency-time

GET /v1/agency/time/report

Time reporting for a period, by person, client and project.

All agency-time endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/agency/time/report \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

⛔ **Unbilled, unpriced and non-billable are three different things and this says which.** Collapsing them is how an agency loses money quietly: hours with no rate card and hours marked internal both contribute nothing to revenue, but one is money about to be lost and the other is a decision they made. `billable_minutes` is the total minus non-billable — *not* "billed". An hour logged as billable and not yet invoiced is billable work, and calling it anything else is how an agency talks itself out of chasing it.

Parameters

NameTypeRequiredWhat it is
org_id (query)stringNo
from (query)stringNoDefaults to the first of the current month.
to (query)stringNoDefaults to today.
client_id (query)stringNo
user_id (query)stringNo

Response

NameTypeRequiredWhat it is
period_startstringYes
period_endstringYes
total_minutesintegerYes
billable_minutesintegerNoTotal minus NON-BILLABLE — ⛔ not "billed". An hour logged as billable and not yet invoiced is billable work, and calling it anything else is how an agency talks itself out of ch…
billed_minutesintegerYes
unbilled_minutesintegerYes
non_billable_minutesintegerYes
billed_minor_by_currencyobjectNo
by_userTimeReportBucket[]No
by_clientTimeReportBucket[]No
by_projectTimeReportBucket[]No

Errors this endpoint can return

401 · 403 · 422