List timesheet periods
Returns your organisation's timesheet periods, newest first: each one's days, its payroll date and how many
timesheets in it are open, waiting for the person to confirm, waiting for approval and approved. Periods follow
your organisation's rules (weekly, fortnightly or monthly) and follow on from each other. Filter by from and to
(periods overlapping them).
Scope: attendance:read · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: attendance:read
limit?integerHow many items to return, from 1 to 100.
1 <= value <= 10025cursor?stringThe next_cursor from the previous page. Leave it out for the first page.
length <= 512from?stringOnly periods ending on or after this day, as YYYY-MM-DD.
dateto?stringOnly periods starting on or before this day, as YYYY-MM-DD.
dateA page of periods.
application/json- response
data*array<>next_cursor*|Pass this as cursor to get the next page. null on the last page.
"b3BhcXVlLWN1cnNvcg"has_more*booleancurl -X GET 'https://api.agoo.ardent.africa/v1/timesheet-periods?limit=25'{ "data": [ { "id": "tsp_01m5a2b3c4d5e6f7g8h9jkmnpr", "kind": "weekly", "starts_on": "2019-08-24", "ends_on": "2019-08-24", "label": "September 2026", "payroll_on": "2019-08-24", "status": "open", "counts": { "open": 0, "to_confirm": 0, "to_approve": 0, "approved": 0 }, "closed_at": "2019-08-24T14:15:22Z", "approved_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}List a person's leave balances GET
Returns this leave year's figures for each type with a yearly balance: `entitled`, `carried` over, `taken`, `adjusted`, `expired`, the `balance`, `booked` (approved, not started) and `pending` (waiting for a decision). Private types aren't listed. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Get a timesheet period GET
Returns one timesheet period. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.