Docs
Account

Identify the calling API key

Returns metadata about the workspace and key behind the request.

GET/api/v1/me

Use it to verify credentials and to discover your workspace id before calling other endpoints — it is the cheapest way to test that a key works, and integrations such as Zapier call it to label connections.

Response 200

Prop

Type

Errors

  • 401 — Missing or invalid API key
  • 429 — Rate limit exceeded

Every error shares one envelope.

Example

curl https://www.hey.support/api/v1/me \
  -H 'Authorization: Bearer hs_live_…'

Errors

One envelope for every failure, with a stable code to branch on.

List chatbots

Returns the workspace’s chatbots, newest first, with their sqid-encoded ids.

On this page

Response 200
Errors
Example