Segments: Get Users

GET /apps/{app_id}/segments/{id}/users

Note

Authentication required.

Path Parameters

Name	Type	Required	Description
app_id	string	No	id of the pulsate app
id	string	No	id of the segment

Headers

Name	Type	Required	Description
Authorization	string	Yes	{my_admin_api_token}
Content-Type	string	No	application/json

Query Parameters

Name	Type	Required	Description
page	string	No	page number
per_page	string	No	records per page
search_query	string	No	keyword to serach users by their lastName, firstName or alias
sort	string	No	sort param to sort by last_name, created_at etc
order	string	No	order param to asc or desc order

Request Example

curl --request GET \
  --url https://control.pulsatehq.com/api/v2/apps/{app_id}/segments/{id}/users \
  --header 'authorization: Token token={my_admin_api_token}' \
  --header 'content-type: application/json'

Responses

200

{
    "data": [
        {
            "id": "63e251a2a8e6aac4ce513f01",
            "alias": "mcksnk",
            "created_at": "2023-02-07T13:26:58Z",
            "current_city": "Muzayri`",
            "full_name": "Lorens, Maciej",
            "last_name": "Lorens",
            "last_session_at": "2024-06-10T13:24:49+00:00"
        }
    ],
    "metadata": {
        "page": 1,
        "per_page": 50,
        "total_pages": 1,
        "data_count": 1,
        "export_users": "/mobile/apps/5ae07be64753364695040000/segments/67e53f48a46a6fad11998005/export_users"
    }
}