Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.replyful.com/llms.txt

Use this file to discover all available pages before exploring further.

The Replyful REST API lets you read your conversation data programmatically. The API is JSON over HTTPS, follows predictable conventions, and is designed to be curl-friendly so you can prototype from the terminal before writing a single line of code. 
curl https://api.replyful.com/v1/conversations?limit=1 \
  -H "Authorization: Bearer rfl_live_..."

​
Base URL

https://api.replyful.com
HTTPS only — plain HTTP requests are rejected, not redirected.

​
Quickstart

1

Create an API key

In the dashboard, go to Settings → Developers → API keys and click Create key. Copy the token — it is shown once and never displayed again.
2

Make your first request

Replace rfl_live_... with your key and run:
curl https://api.replyful.com/v1/conversations?limit=1 \
  -H "Authorization: Bearer rfl_live_..."
3

Read the response

You get a list envelope with a single conversation:
{
  "object": "list",
  "data": [
    {
      "id": "conv_...",
      "object": "conversation",
      "title": "Refund request",
      "status": "needs_first_response",
      "supportLevel": "ai",
      "channel": { "id": "chan_...", "name": "Support inbox", "type": "email" },
      "contact": { "id": "ct_...", "name": "Ada Lovelace", "email": "[email protected]" },
      "lastMessagePreview": "Hi, I'd like a refund on my last order...",
      "topics": [],
      "createdAt": "2026-04-29T14:30:00Z",
      "updatedAt": "2026-04-29T14:32:00Z",
      "waitingSince": "2026-04-29T14:32:00Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null,
  "url": "/v1/conversations"
}

​
Conventions

Every endpoint in the API follows the same rules. Learn them once, apply them everywhere.
ConventionWhat to expect
AuthBearer token in the Authorization header. See Authentication.
FormatJSON request and response bodies. UTF-8.
Field namescamelCase everywhere.
TimestampsISO 8601 UTC strings, always with the trailing Z (e.g. 2026-04-29T14:32:00Z).
IDsPrefixed strings like conv_..., chan_..., ct_.... Treat them as opaque.
PaginationCursor-based. See Pagination.
ErrorsStatus code is the source of truth. Body uses a consistent envelope. See Errors.
Rate limitsDocumented headers on every response. See Rate limits.
TracingEvery response includes a Request-Id header — quote it in support tickets.

​
What’s available today

The API is in active development. Today, the following endpoint is live:

GET /v1/conversations

List conversations with filtering, search, sorting, and cursor pagination.
More endpoints will land here as they ship. Field names, error codes, and ID prefixes are part of the public contract — they will not change without a major version bump.

​
Need help?

Quote the Request-Id from any response when you contact support. We keep request traces for 90 days and can pull the exact context of a failing call from that ID.