List members

Returns a paginated list of members in the community associated with your API key, sorted by creation date (newest first).

Pagination

This endpoint uses cursor-based pagination. To get the next page, pass the id of the last member in the current response as starting_after. Repeat until has_more is false.

Responses don’t include page numbers or a total count. A cursor points to a specific member rather than a row offset, so page boundaries stay stable even while new members are being added.

Members created during a scan

Results are sorted newest first, so any member created after you start paging lands ahead of your cursor and won’t appear in that scan. A completed scan contains the members that existed when you started, not when you finished. To pick up newer members, start a new request without starting_after.

Filtering

Every query parameter other than limit and starting_after is a filter. Filters narrow which members are returned but don’t change the response shape, so filtered requests paginate the same way as unfiltered ones. An empty data array means no members matched, not that the request failed. See each parameter for its matching rules.

Query Params
string
^\+[1-9]\d{6,14}$

Returns only the members with this phone number. Send the number in E.164 format. Encode the
+ as %2B.

More than one member can match. A person on sms and on whatsapp is two members with the
same phone number. The response contains both members, so read the full list.

A whatsapp member matches on its WhatsApp phone number, also after it moves to a WhatsApp
user id. Most amb members have no phone number. This filter does not return them.

string
^[^@\s]+@[^@\s]+\.[^@\s]+$

Returns only members whose profile carries this address. Matched without regard to case, so
[email protected] and [email protected] find the same member.

An address is not unique: the same person subscribed on two channels is two members sharing
one, and both are returned. Read the whole list rather than the first entry.

Members with no address on file match nothing here, including every member whose profile
predates the address being collected.

string
enum

Returns only the member at communication_channel_id on this channel. Send it together with
communication_channel_id. If you send only one of the two, the response is a 400.

amb addresses are not published, so amb returns no members.

Allowed:
string
length between 1 and 255

Returns only the member at this address. Send the value that the member's
communication_channel_id field shows. Send it together with communication_channel.

For sms, send the phone number in E.164 format. For whatsapp, send the phone number in
E.164 format or the WhatsApp user id. A value that starts with + or has only digits is a
phone number. If a phone number is not in E.164 format, the response is a 400. Encode the +
as %2B.

After a member moves to a WhatsApp user id, only the user id matches here. Use phone_number
to find the member by phone.

integer
1 to 100
Defaults to 25

How many members to return. Defaults to 25, maximum 100.

uuid

A member id. Returns the page that follows it. Pass the id of the last member in the
previous response, and repeat until has_more is false.

Headers
string

Pins the API version for this request as YYYY-MM-DD. Defaults to the version pinned to your
credential.

Responses

Callback
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json