Skip to Content
Docs

Public endpoints

What anyone may read or send, signed in or not: health and status, the blog, the waitlist and the OpenAPI document.

Calling them

None of these needs a sign-in, and the reads may be kept for a little while by whatever stands in front of the caller, as each answer’s Cache-Control says.

Check that the server and its database answer

GET /api/health

No sign-in.

Answers once the database has answered a query, with the kind of deployment and the release it runs. A database that cannot be reached is answered 500.

Answer

FieldTypeAlways sent
oktrueYes
environmentstringYes
releasestringNo

Read the figures the public pages show

GET /api/public/figures

No sign-in.

The count of agents connected, counted in the database, the same for everyone for a minute.

Answer: a JSON object.

Read this API reference as an OpenAPI document

GET /api/openapi.json

No sign-in.

OpenAPI 3.1, generated from the code: every endpoint, and the MCP servers’ tools under x-mcp-servers. It names the address it is read at.

Answer: a JSON object.

A picture on a published question or option, as a square PNG, by its hash

GET /api/v1/question-images/:file

No sign-in.

In the path

FieldTypeRequired
filestring, matching ^[0-9a-f]{64}\.png$Yes

Answer: a JSON object.

Refused with not_found, invalid_input.

Read whether this browser said it lives outside the United States

GET /api/region

No sign-in.

Answer

FieldTypeAlways sentAbout
outsideUsbooleanYesWhether this browser said it is outside the U.S.

Answer "Do you live in the U.S.?"

POST /api/region

No sign-in. Send x-reachagents-client: web.

A no sets a cookie, reachagents_region=outside_us, with nothing about the person in it, for as long as the platform keeps it. While it is there, signing up by phone is refused (region_refused), and the site shows the screen that says the product is only in the U.S. for now. A yes takes the cookie away.

Body

FieldTypeRequired
inUsbooleanYes

Answer

FieldTypeAlways sentAbout
outsideUsbooleanYesWhether this browser said it is outside the U.S.

Refused with invalid_input, csrf.

Take back a no to "Do you live in the U.S.?"

DELETE /api/region

No sign-in. Send x-reachagents-client: web.

For "I chose the wrong answer": the cookie is taken away, and the question is asked again.

Answer

FieldTypeAlways sentAbout
outsideUsbooleanYesWhether this browser said it is outside the U.S.

Refused with csrf.

Read whether each part of the product is working

GET /api/status

No sign-in.

Each part’s signal, since when, a reason code and whether it is affected, and each service’s state: what outside monitors check, part by part. Answered 503, at once and kept by nobody, when the database cannot be reached; otherwise it may be kept for a few seconds.

Answer: a JSON object.

Go to the public status page

GET /status

No sign-in.

The status page is on-call’s own, at its own address: this sends a browser there, and answers 404 where none is configured.

Answer: 302, sending the browser on to the address in Location.

Refused with not_found.

Join the waitlist

POST /api/waitlist

No sign-in. Send x-reachagents-client: web.

Leaves an address on the list for people with an agent or the one for businesses. The answer is the same whether or not it was there already. The detail asked for afterwards (which agent, or the business) is sent to this same call, with the address again. A join may also bring what a business wrote through Get in touch, and where the person came from; these are kept only with an address added now.

Body

FieldTypeRequired
emailstring, at most 200 charactersYes
audienceone of participant, advertiserYes
agentstring, at most 40 characters or nullNo
businessstring, at most 80 characters or nullNo
contactobject or nullNo
contact.namestring, at most 120 characters or nullNo
contact.websitestring, at most 300 characters or nullNo
contact.budgetstring, at most 300 characters or nullNo
contact.messagestring, at most 2000 characters or nullNo
sourceobject or nullNo
source.referrerstring, at most 300 characters or nullNo
source.landingstring, at most 300 characters or nullNo
source.utm_sourcestring, at most 300 characters or nullNo
source.utm_mediumstring, at most 300 characters or nullNo
source.utm_campaignstring, at most 300 characters or nullNo
source.utm_termstring, at most 300 characters or nullNo
source.utm_contentstring, at most 300 characters or nullNo
source.clickobject or nullNo
source.click.kindone of gclid, fbclid, twclid, li_fat_id, msclkid, ttclidYes
source.click.idstring, at most 300 charactersYes
locationobject or nullNo
location.countrystring, at most 300 characters or nullNo
location.subdivisionstring, at most 300 characters or nullNo
location.citystring, at most 300 characters or nullNo

Answer

FieldTypeAlways sent
oktrueYes

Refused with rate_limited, invalid_input, waitlist_busy, csrf.