Skip to main content
POST
Filter contacts

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Query Parameters

top
integer

Maximum number of contacts to return (default 25, max 1000)

skip
integer

Number of contacts to skip

Body

application/json
rules
object[]
listId
integer | null

Filter by contact list ID

sequenceId
integer | null

Filter by sequence ID

sequenceStepId
integer | null

Filter by sequence step ID

searchTerm
string | null

Free-text search term

sortBy
string | null

Field to sort by

sortDirection
string | null

Sort direction (asc or desc)

Response

Filtered contacts retrieved successfully

items
Contact · object[]
hasMore
boolean

Indicates if there are more items to fetch