Docs
API referenceVisitors

Erase a visitor

Preview· P9
DELETE/visitors/{visitor_id}

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.

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: visitors:delete

Path Parameters

visitor_id*string

The visitor's ID.

Match^visitor_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"visitor_01krdtb870fxj8t6ntdtcxwdk5"

Response Body

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://example.com/visitors/visitor_01krdtb870fxj8t6ntdtcxwdk5"
Empty

Get a visitor GET

Returns one visitor record. To see their visits, call `GET /visits?visitor_id=…`. In live mode, a visitor whose visits are all hidden by your plan's visitor history returns `plan_required`. **Scope:** `visitors:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

List deliveries GET

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.