Skip to main content
GET
Get a conversation

Authorizations

Authorization
string
header
required

An API key of one app, sent as Authorization: Bearer <key>. Keys start with fk_test_ (test mode: sandbox senders and test data only) or fk_live_ (live mode). Keep live keys on your server; never ship them in an app or page.

Headers

Flow-Version
string<date>

The API version to use, as a date. Without it, the version pinned to your app when it was created is used.

Example:

"2026-11-01"

Path Parameters

conversation_id
string
required

The conversation's ID. A conversation ID, conv_ and a ULID.

Pattern: ^conv_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"conv_01JB8ZC3K5M7P9R1T3V5X7Z9B1"

Response

The conversation.

One sender talking with one contact. Holds the window state and whether the contact opted in.

id
string
required

A conversation ID, conv_ and a ULID.

Pattern: ^conv_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"conv_01JB8ZC3K5M7P9R1T3V5X7Z9B1"

app
string
required

An app ID, app_ and a ULID.

Pattern: ^app_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"app_01JB8Z0A1C3E5G7J9K1M3P5R7T"

channel
enum<string>
required

A messaging channel.

Available options:
telegram,
whatsapp,
imessage
sender
string
required

A sender ID, snd_ and a ULID.

Pattern: ^snd_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"snd_01JB8Z4Q3V6W0R2N7C5H1M9K4T"

contact
string
required

A contact ID, ct_ and a ULID.

Pattern: ^ct_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"ct_01JB8ZB2J4K6N8Q0S2V4W6Y8A0"

livemode
boolean
required

Whether the conversation belongs to live mode.

opted_in
boolean
required

Whether the contact has agreed to receive messages (wrote first, joined the sandbox, or you recorded consent).

created_at
string<date-time>
required

When the conversation began.

last_inbound_at
string<date-time>

When the contact last wrote. Absent if they never have.

window_open_until
string<date-time>

WhatsApp only. Until when free-form messages may be sent; after it, only templates. Absent when the window is closed or the channel has none.

metadata
object

Up to 20 string pairs of your own, kept with the object and returned unchanged. Keys up to 40 characters, values up to 500.