Docs
API referenceDeliveries

List deliveries

Preview· P9
GET/deliveries

Returns deliveries, newest first. Use status=received to see parcels still waiting at reception.

Scope: deliveries:read · Plan: Pro and Enterprise in live mode; every plan in test mode.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs 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.

In: header

Scope: deliveries:read

Query Parameters

limit?integer

How many items to return, from 1 to 100.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor from the previous page. Leave it out for the first page.

Lengthlength <= 512
status?string

Only deliveries with this status.

Value in

  • "received"
  • "collected"
site_id?string

Only deliveries received at this site.

Match^site_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"site_01kjpt3yw0fz0v414608h9x65s"
recipient_id?string

Only deliveries for this person.

Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"person_01kjsesxm0e4zbyvkr7bcfxbfg"
created_after?string

Only items created at or after this time.

Formatdate-time
created_before?string

Only items created before this time.

Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/deliveries?limit=25&status=received&created_after=2026-10-01T00%3A00%3A00Z&created_before=2026-11-01T00%3A00%3A00Z"
{  "data": [    {      "id": "delivery_01m4x0bj50e43vcf8bz0ar7qhp",      "status": "received",      "site_id": "site_01kjpt3yw0fz0v414608h9x65s",      "recipient_id": "person_01kjsesxm0e4zbyvkr7bcfxbfg",      "sender": "Coastline Consult",      "carrier": "Dispatch rider",      "tracking_number": null,      "description": "Signed engagement letter",      "package_count": 1,      "received_at": "2026-10-14T10:47:00Z",      "received_by": "person_01kjsevr70faybwar4k1wjj6x2",      "collected_at": null,      "collected_by_name": null,      "created_at": "2026-10-14T10:47:00Z",      "updated_at": "2026-10-14T10:47:00Z"    }  ],  "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 received at a site, for example from your own mailroom system. With `notify_recipient` (the default), Agoo tells the recipient by their notification preferences. Fires `delivery.received`. **Scope:** `deliveries:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.