- Getting started
- Metrics
- Idea manager
- Feedback Collection
- Segments
- Retrieves a list of segments without usersGET
- Create segmentPOST
- Modify a segmentPUT
- Removes a segmentDELETE
- Bulk create users to a segmentPOST
- Manage user segments: move or removePUT
- Retrieve segments with usersGET
- Retrieve segment with usersGET
- Import Users (CSV/JSON)POST
- Sending email to segment membersPOST
- Sending email to selected idm membersPOST
- Bulk create idea manager membersPOST
- Import Users (CSV/JSON) in IDMPOST
- Bulk re-invite in IDMPUT
- Backlog Management
- Strategy Board
- Persona Board V2
- Segments
- Custom fields
- Removes a custom field
- Retrieve a list of custom fields
- Retrieve a custom field
- Create a custom field
- Removes a custom field option
- Detaches a custom field from persona
- Retrieve custom fields excluding persona
- Creates a new option
- Permanently deletes a custom field
- Update custom field
- Update custom field option
- Attach a custom field to a persona
- Create opportunities from summary
- Retrieve notes
- Retrieve persona
- Retrieve experiments for Persona
- Create
- Retrieve
- DocsHub
Retrieve segments with users
GET
/api/v2/segments/with-users
Request
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.shorterloop.com/api/v2/segments/with-users' \
--header 'Authorization;' \
--header 'initiativeId;'Responses
🟢200OK
application/json
Body
Examples
{
"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