Retrieve segments with users

GET

/api/v2/segments/with-users

Endpoint

GET /api/v2/segments/with-users

Description

Retrieves all segment options, including associated users and an optional count of users in each segment.

Request Example

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.shorterloop.com/api/v2/segments/with-users' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc' \
--header 'initiativeId: DEE' \
--header 'Content-Type: application/json'

Responses

🟢200OK

application/json

Body

{
    "success": true,
    "data": [
        {
            "id": 15,
            "value": "Value Seekers",
            "createdAt": "2024-10-24T04:46:27.000Z",
            "users": [],
            "userCount": 0
        },
        {
            "id": 16,
            "value": "Luxury Shoppers",
            "createdAt": "2024-10-24T04:46:29.000Z",
            "users": [],
            "userCount": 0
        },
        {
            "id": 17,
            "value": "Eco-Conscious Consumers",
            "createdAt": "2024-10-24T04:46:29.000Z",
            "users": [],
            "userCount": 0
        },
        {
            "id": 18,
            "value": "Budget Conscious Families",
            "createdAt": "2024-10-24T08:10:55.000Z",
            "users": [
                {
                    "id": 1670,
                    "email": "aarav.patel20@shorterloop.com",
                    "user_subscriptions": [
                        {
                            "firstName": null,
                            "userRole": "idm_member",
                            "status": "pending"
                        }
                    ],
                    "segmentOptions": [
                        {
                            "value": "Budget Conscious Families",
                            "user_segment": {
                                "userId": 1670,
                                "segmentOptionId": 18,
                                "initiativeId": 0,
                                "teamId": 0,
                                "subscriptionId": 0,
                                "createdAt": "2024-10-24T11:44:11.000Z",
                                "updatedAt": "2024-10-24T11:44:11.000Z"
                            }
                        },
                        {
                            "value": "Young Innovators",
                            "user_segment": {
                                "userId": 1670,
                                "segmentOptionId": 19,
                                "initiativeId": 0,
                                "teamId": 0,
                                "subscriptionId": 0,
                                "createdAt": "2024-10-24T11:41:21.000Z",
                                "updatedAt": "2024-10-24T11:41:21.000Z"
                            }
                        }
                    ]
                },
                {
                    "id": 1671,
                    "email": "isha.sharma19@shorterloop.com",
                    "user_subscriptions": [
                        {
                            "firstName": null,
                            "userRole": "idm_member",
                            "status": "pending"
                        }
                    ],
                    "segmentOptions": [
                        {
                            "value": "Budget Conscious Families",
                            "user_segment": {
                                "userId": 1671,
                                "segmentOptionId": 18,
                                "initiativeId": 0,
                                "teamId": 0,
                                "subscriptionId": 0,
                                "createdAt": "2024-10-24T11:44:11.000Z",
                                "updatedAt": "2024-10-24T11:44:11.000Z"
                            }
                        },
                        {
                            "value": "Young Innovators",
                            "user_segment": {
                                "userId": 1671,
                                "segmentOptionId": 19,
                                "initiativeId": 0,
                                "teamId": 0,
                                "subscriptionId": 0,
                                "createdAt": "2024-10-24T11:41:21.000Z",
                                "updatedAt": "2024-10-24T11:41:21.000Z"
                            }
                        }
                    ]
                },
                {
                    "id": 1672,
                    "email": "rohan.mehta18@shorterloop.com",
                    "user_subscriptions": [
                        {
                            "firstName": null,
                            "userRole": "idm_member",
                            "status": "pending"
                        }
                    ],
                    "segmentOptions": [
                        {
                            "value": "Budget Conscious Families",
                            "user_segment": {
                                "userId": 1672,
                                "segmentOptionId": 18,
                                "initiativeId": 0,
                                "teamId": 0,
                                "subscriptionId": 0,
                                "createdAt": "2024-10-24T11:44:11.000Z",
                                "updatedAt": "2024-10-24T11:44:11.000Z"

Modified at 2024-10-29 00:42:46

Manage user segments: move or remove

Retrieve segment with users