List deliveries
Returns deliveries, newest first. Use status=waiting to see parcels still waiting at reception (received or notified).
Scope: deliveries: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: deliveries: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 <= 512status?stringOnly deliveries with this status.
"received""notified""collected""returned""refused""waiting"site_id?stringOnly deliveries received at this site.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"recipient_id?stringOnly deliveries for this person.
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"team_id?stringOnly deliveries for this team.
^team_[0-7][0-9a-hjkmnp-tv-z]{25}$"team_01m4r6y616e1b973vj50h0643y"created_after?stringOnly items created at or after this time.
date-timecreated_before?stringOnly items created before this time.
date-timeA page of deliveries.
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.agoohq.com/v1/deliveries?limit=25&status=waiting&created_after=2026-10-01T00%3A00%3A00Z&created_before=2026-11-01T00%3A00%3A00Z'{ "data": [ { "id": "delivery_01m4x0bj50e43vcf8bz0ar7qhp", "status": "notified", "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "recipient_type": "person", "recipient_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "team_id": null, "for": "Kwabena Adjei, Accounts", "kind": "envelope", "size": "small", "location": "Shelf B", "sender": "Coastline Consult", "carrier": "Dispatch rider", "tracking_number": null, "description": "Signed engagement letter", "package_count": 1, "rider_name": "Yaw Boateng", "rider_phone": 233244000111, "source": "console", "received_at": "2026-10-14T10:47:00Z", "received_by": "person_01kjsevr70faybwar4k1wjj6x2", "notified_at": "2026-10-14T10:47:05Z", "reminders_sent": 0, "collected_at": null, "collection_method": null, "collected_by": null, "collected_by_name": null, "handed_over_by": null, "returned_at": null, "return_reason": null, "label_file_id": "file_01m4x0bh10e43vcf8bz0ar7qhn", "photo_file_ids": [], "created_at": "2026-10-14T10:47:00Z", "updated_at": "2026-10-14T10:47:05Z" } ], "next_cursor": null, "has_more": false}Erase a visitor DELETE
Permanently erases a visitor's personal data, for example to act on an erasure request under the Data Protection Act, 2012 (Act 843). This can't be undone. - Agoo removes the visitor's name, contact details, photo, ID document details and custom field answers from the visitor record and all their visits. The visits stay, without personal data, so your counts and the audit trail remain whole. - Fires `visitor.erased`. Later calls for this visitor return `not_found`. - Works on visitors and visits hidden by your plan's visitor history too, so an erasure request is always complete. - Returns `invalid_state` if the visitor is checked in right now or their data is under a legal hold. **Scope:** `visitors:delete` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Record a delivery POST
Records a parcel, envelope or food received at a site, for a person, a team or the front desk, for example from your own mailroom system. With `notify_recipient` (the default), Agoo tells the recipient (or each member of the team) by their notification preferences, with a one-time collection code, and reminds them until it's collected, as the organisation's settings say. Upload photos first (`POST /files`, kind `delivery_label` or `delivery_photo`). Fires `delivery.received`. **Scope:** `deliveries:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.