agency-time

GET /v1/agency/time/schedules

When each client is invoiced.

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.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

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/schedules \
  -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

One row per client, plus one org-wide default (`client_id: null`) covering every client without a row of its own. A per-client row **replaces** the default rather than layering on it — merging two partial schedules would let one client be billed twice. Both cursor columns are on the wire. `last_attempted_at` is advanced for every schedule the sweep reaches, before its result is read; `last_succeeded_at` is what a staleness alarm reads. A screen showing only the first cannot tell a healthy client from one that has been failing for a month.

Parameters

NameTypeRequiredWhat it is
limit (query)integerNoMaximum items to return (page size).
cursor (query)stringNoOpaque cursor from a previous page's `page.next_cursor`.

Response

NameTypeRequiredWhat it is
dataTimeBillingSchedule[]Yes
pagePageMetaYes

Errors this endpoint can return

401 · 403