Skip to main content
GET
List contacts

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"

Query Parameters

after
string

An item ID. Returns the items that come after it in the list's order.

Maximum string length: 64
before
string

An item ID. Returns the items that come before it in the list's order.

Maximum string length: 64
limit
integer
default:20

How many items to return, 1 to 100.

Required range: 1 <= x <= 100
channel
enum<string>

Only contacts on this channel. A messaging channel.

Available options:
telegram,
whatsapp,
imessage

Response

A page of contacts.

A page of contacts.

data
object[]
required
has_more
boolean
required

Whether more items lie beyond this page in the direction you paged.