Docs

List contacts

Preview· P9
GET
/contacts

Returns contacts, most recently active first, by cursor. A special-category or restricted field never leaves through a key.

Scope: contacts:read

Authorization

headerAuthorizationBearer <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
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs 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 partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs 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

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

Active by default.

Default"active"
Value in"active""archived"
q?string

A name, or an exact phone or email.

owner?string

Only contacts this person owns.

lifecycle?string

Only contacts at this stage.

company?string

Only contacts at this company.

tag?string

Only contacts with this tag.

list?string

Only contacts on this list.

segment?string

Only contacts this segment matches.

Response Body

A page of contacts.

application/json
  1. response
data*array<>
has_more*boolean
next_cursor*string
curl -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"}