API referenceCompanies
List companies
Preview· P9
GET
By name, by cursor.
Scope: contacts:read
header
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.
Range
1 <= value <= 100Default
25cursor?stringThe next_cursor from the previous page. Leave it out for the first page.
Length
length <= 512q?stringThe start of a company's name.
A page of companies.
application/json- response
data*array<>has_more*booleannext_cursor*stringcurl -X GET 'https://api.agoohq.com/v1/companies?limit=25'{ "data": [ { "id": "string", "name": "string", "domains": [ "string" ], "phone": "string", "email": "string", "industry": "string", "size_band": "string", "tin": "string", "parent": {}, "owner": {}, "status": "active", "version": 0 } ], "has_more": true, "next_cursor": "string"}