GET
/
api
/
segments
List Tenant Segments
curl --request GET \
  --url https://api.embedreach.com/api/segments
{
  "success": true,
  "message": "<string>",
  "data": {
    "results": [
      {
        "results": [
          {
            "id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "createdAt": "<string>",
            "type": "all_users",
            "userCount": 123,
            "phoneCount": 123,
            "emailCount": 123,
            "userCountUpdatedAt": "<string>"
          }
        ],
        "pagination": {
          "hasNextPage": true,
          "cursor": "<string>",
          "total": 123
        }
      }
    ],
    "pagination": {
      "total": 123,
      "hasNextPage": true,
      "cursor": "<string>"
    }
  }
}

Headers

reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Query Parameters

cursor
string

The cursor to start from

limit
number | null

The limit of items to return, default is 100

The search query to filter by segment name

Response

200
application/json

Status 200 response

The response is of type object.