Docs
Chatbots

List chatbots

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

GET/api/v1/chatbots

Call this first to discover the chatbot_id that every other scoped endpoint expects.

Query parameters

Prop

Type

Response 200

Returns a data array with a pagination object. Each item:

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/chatbots \
  -H 'Authorization: Bearer hs_live_…'

Identify the calling API key

Returns metadata about the workspace and key behind the request.

List conversations

Returns a paginated list of chat conversations for the workspace, newest first.

On this page

Query parameters
Response 200
Errors
Example