curl --request GET \
--url https://api.embedreach.com/api/segments{
"success": true,
"message": "<string>",
"data": {
"results": [
{
"results": [
{
"id": "<string>",
"name": "<string>",
"createdAt": "<string>",
"type": "all_users",
"userCount": 123,
"phoneCount": 123,
"emailCount": 123,
"userCountUpdatedAt": "<string>",
"description": "<string>"
}
],
"pagination": {
"hasNextPage": true,
"cursor": "<string>",
"total": 123
}
}
],
"pagination": {
"hasNextPage": true,
"total": 123,
"cursor": "<string>"
}
}
}List all tenant segments
curl --request GET \
--url https://api.embedreach.com/api/segments{
"success": true,
"message": "<string>",
"data": {
"results": [
{
"results": [
{
"id": "<string>",
"name": "<string>",
"createdAt": "<string>",
"type": "all_users",
"userCount": 123,
"phoneCount": 123,
"emailCount": 123,
"userCountUpdatedAt": "<string>",
"description": "<string>"
}
],
"pagination": {
"hasNextPage": true,
"cursor": "<string>",
"total": 123
}
}
],
"pagination": {
"hasNextPage": true,
"total": 123,
"cursor": "<string>"
}
}
}If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
The cursor to start from
The limit of items to return, default is 100
The search query to filter by segment name
Status 200 response
Show child attributes
Show child attributes
The segments
Show child attributes
The id of the segment
A friendly name for the segment
The date and time the segment was created
The type of segment
all_users, managed, custom, one_off, sql The number of users in the segment
The number of phone numbers in the segment
The number of emails in the segment
The date and time the user count was updated
A friendly name for the segment