Get list of all segments

We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

Get list of all segments

Retrieves a paginated list of segments based on query parameters.

SecurityAuthorizationToken

Request

query Parameters

limit	number Number of records returned on a single page. Default is `10` if `limit` is not specified
offset	number Number of records you wish to skip before selecting records. Default is `0` if not specified

header Parameters

required	object Valid JSON object that must contain account, stage, date, and channel attributes. eg - {"stage":"prod","account":"5f328bf0b","date":"2020-12-12T08:00:00.000Z","channel":12}
Authorization required	string Authorization token or access token for the user, provided by fabric. It can be obtained after logging into fabric's copilot account. Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Responses

200

400

Bad Request

500

Internal Server Error

get/api-offers/segment/list

Response samples

application/json

{"query": {"limit": 10,
"count": 150,
"offset": 0
},
"data": [{"_id": "614b58924e92f6861ac9d43b",
"segmentId": 100002,
"name": "Customer Type",
"value": ["High Spender"
],
"deleted": false,
"createdAt": "2020-12-14T12:15:43.646Z",
"updatedAt": "2021-12-14T12:15:43.646Z"
}
]
}