Customer StoriesYespo Blog
Developer Guide
Request DemoLogin

Get contacts from a segment

get
https://yespo.io/api/v1/group//contacts

The method is used to search for all contacts in a segment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Note

There's no parameter for filtering contacts by the date they were added to the segment. To read the most recent additions, set orderByTs=true together with asc=false and page through the result from the start.

Path Params
int32
required

Segment ID

Query Params
int32
Defaults to 1

The index of the first contact returned from the search result.
Numbering starts at 1

int32
Defaults to 500

Maximum number of contacts to return (max. 500)

boolean
Defaults to false

Order by the time of addition to the segment.

boolean
Defaults to true

Sort in ascending (ASC) or descending (DESC) order.

Response

Updated 7 days ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=UTF-8

Updated 7 days ago

Did this page help you?