List contacts
Returns contacts, most recently active first, by cursor. A special-category or restricted field never leaves through a key.
Scope: contacts:read
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 |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
agoo_ck_live_ | Check API key, live mode, for a Check API partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As above, answering only the published test values, never billed |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: contacts: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?stringActive by default.
"active""active""archived"q?stringA name, or an exact phone or email.
owner?stringOnly contacts this person owns.
lifecycle?stringOnly contacts at this stage.
company?stringOnly contacts at this company.
tag?stringOnly contacts with this tag.
list?stringOnly contacts on this list.
segment?stringOnly contacts this segment matches.
A page of contacts.
application/json- response
data*array<>has_more*booleannext_cursor*stringcurl -X GET 'https://api.agoohq.com/v1/contacts?limit=25'{ "data": [ { "id": "string", "display_name": "string", "given_name": "string", "family_name": "string", "preferred_name": "string", "honorific": "string", "job_title": "string", "status": "active", "lifecycle": "string", "source": "string", "company": {}, "owner": {}, "phone": "string", "email": "string", "identities": [ {} ], "marketing": [ "email" ], "minor": true, "first_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z", "last_activity_at": "2019-08-24T14:15:22Z", "merged_from": "string", "version": 0 } ], "has_more": true, "next_cursor": "string"}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.
Create a contact POST
Held by the plan's contact limit. A phone or email already held is 409, and nothing merges silently. Numbers are read the way people write them. **Scope:** `contacts:write`