Skip to main content
GET
Search message recipients

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

user[email]
string<email>

Email of the company admin to act as. Required: it must match an admin recipient in the company's messaging.

kind
enum<string>

What to search: external, sms, or email for contacts; omit for company members.

Available options:
external,
sms,
email
filterrific[search_query]
string

Text to match against names and contact details.

filterrific[sorted_by]
string

Sort order. Defaults to first_name_asc.

page
integer

Page number, starting at 1.

Required range: x >= 1
per_page
integer

Recipients per page. Defaults to 20.

Required range: x >= 1

Response

Success

A page of recipients, as a two-item array. The first item holds the pagination details and the second holds the recipients.

[0]
object
[1]
object