Get list of segments

API at a glance

Description: This API retrieves a list of segments with filtering and pagination options. Segments are groups of users that meet specific criteria and are used for targeted campaigns.

Authentication & testing

Testing the API on this page

How to try it here

Use your User API Key as the Username (leave Password blank).

Select the appropriate API endpoint based on your Blueshift region.

Enter the necessary parameters and click Try It to run the request.

Authentication using Base64 encoding

Note for developers

API requests require authentication using HTTP Basic Authentication with an API key. The API key serves as the username, while the password field should be left empty. The format to encode is: your_api_key: (note the trailing colon).

This string must be Base64-encoded and included in the request's Authorization header as follows:

Authorization: Basic encoded_value

You can generate the encoded value using a trusted Base64 encoder.

Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.

Things to know before you start

Filtering: Filter segments by name (substring match) and archived status.
Pagination: Use page and per_page parameters to paginate through results.
Archived status: 0 for unarchived, 1 for archived, omit for all segments.
User counts: Response includes approximate counts for total users, emailable users, SMS users, and push-enabled users.
Use case: Best for listing available segments, auditing segment inventory, and integrating segment data with external systems.

Request parameters

Check out the request parameters

Query parameters

Note: All query parameters are optional.

Parameter	Type	Required	Description
`name`	`string`	❌ No	Search for segments containing this string in the name.
`archived`	`integer`	❌ No	`0` for unarchived, `1` for archived, omit for all segments.
`per_page`	`string`	❌ No	Number of records to return per page.
`page`	`string`	❌ No	Page number for the search results.

Example requests & responses

Get all segments

GET /api/v1/segments/list

{
  "segments": [
    {
      "name": "High value customers",
      "uuid": "e24f90d8-53df-46fd-8014-ff1bfa8774b5",
      "mixin_key": null,
      "created_at": "2024-08-25T06:06:59.412Z",
      "updated_at": "2021-08-25T06:06:59.412Z",
      "status": "active",
      "approxusers": 15000,
      "email_users": 12000,
      "sms_users": 8000,
      "push_users": 5000,
      "approxusers_updated_at": 1640995200,
      "version": 2
    }
  ]
}

Get unarchived segments with name filter

GET /api/v1/segments/list?name=high&archived=0&per_page=10&page=0

{
  "segments": [
    {
      "name": "High value customers",
      "uuid": "e24f90d8-53df-46fd-8014-ff1bfa8774b5",
      "mixin_key": null,
      "created_at": "2024-08-25T06:06:59.412Z",
      "updated_at": "2021-08-25T06:06:59.412Z",
      "status": "active",
      "approxusers": 15000,
      "email_users": 12000,
      "sms_users": 8000,
      "push_users": 5000,
      "approxusers_updated_at": 1640995200,
      "version": 2
    }
  ]
}

API error responses

Note
The following error codes are commonly returned by Blueshift APIs. Depending on the specific endpoint, not all may apply.

Status code	Description	Example responses
400 Bad Request	The request is invalid due to missing or incorrect parameters. This includes missing fields, invalid values, formatting issues, or conflicts such as duplicate data.	`{ "errors": { "name": ["can't be blank"] } }` `{ "errors": { "startdate": ["can't be blank"] } }`
401 Unauthorized	API authentication failed due to an invalid or missing API key.	`{ "message": "Not authorized" }`
403 Forbidden	The API key does not have sufficient permissions to perform this action.	`{ "message": "Permission denied" }`
404 Not Found	The specified campaign was not found. Verify the campaign UUID.	`{ "message": "Campaign not found" }`
422 Unprocessable Entity	The campaign cannot be paused due to its current status (e.g., already completed or archived). One or more scheduling parameters may be invalid (if applicable).	`{ "message": "Campaign cannot be paused in its current status." }` `{ "message": "Invalid schedule values" }`
429 Too Many Requests	The request limit has been exceeded. Reduce request frequency.	`{ "message": "Rate limit exceeded" }`
500 Internal Server Error	An unexpected server error occurred. Contact support if the issue persists.	`{ "message": "Internal Server Error - Please contact support for more information." }`
502 Bad Gateway	The server received an invalid response. Retry the request.	`{ "message": "Bad Gateway - Please retry the request." }`
503 Service Unavailable	The service is temporarily unavailable. Try again later.	`{ "message": "Service Unavailable - The service is temporarily unavailable. Try again later." }`
504 Gateway Timeout	The server took too long to respond. Retry the request with exponential backoff.	`{ "message": "Gateway Timeout - The server took too long to respond. Retry with exponential backoff." }`