Skip to main content
GET
Get a contact

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

contact_id
string
required

The contact's ID. A contact ID, ct_ and a ULID.

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

"ct_01JB8ZB2J4K6N8Q0S2V4W6Y8A0"

Response

The contact.

A person on one channel. There is no cross-channel identity, and a contact may have no phone number at all (a Telegram user, a WhatsApp username, an iMessage email handle).

id
string
required

A contact ID, ct_ and a ULID.

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

"ct_01JB8ZB2J4K6N8Q0S2V4W6Y8A0"

channel
enum<string>
required

A messaging channel.

Available options:
telegram,
whatsapp,
imessage
livemode
boolean
required

Whether the contact belongs to live mode.

address
object
required

How the contact is reached on their channel. Which fields are set depends on the channel; do not assume phone.

created_at
string<date-time>
required

When Flow first saw the contact.

name
string

The contact's display name, as the channel reports it. May change or be missing.