get
https://api.getblueshift.com/api/v1/account_algorithms.json
Returns the recommendation schemes configured for your account, including the scheme UUID, display name, editor version, author, and linked templates.
API at a glance
Description: This API returns the recommendation schemes configured for your Blueshift account, including the scheme UUID you pass to recommendation API calls, its display name, editor version, author, and the templates that use it.
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_valueYou 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
- Two response formats: Without the
pageparameter, the endpoint returns a plain array containing every scheme in your account. Withpage, it returns a paginated object withtotal_count,total_pages,per_page,page, and aresultsarray. per_pagerequirespage: On its own,per_pagehas no effect. Pass both to control page size.- Archived filter uses
0and1: Setarchived=1for archived schemes andarchived=0for active ones. Boolean values are not accepted. - Editor versions:
V1.0is Classic,V1.1is Plasma, andV2.0is Photon. An unrecognised value returns a400. - Scheme UUID: Use the
uuidfield from the response when you call the recommendations API. - Use case: Best for auditing your recommendation schemes, finding the UUID of a scheme programmatically, and checking which templates use a given scheme.
Request parameters
Check out the request parameters
Query parameters
Note: All query parameters are optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | ❌ No | Page number to return, starting at 0. Include this parameter to get a paginated response. |
per_page | integer | ❌ No | Number of schemes per page. Default is 25. Requires page. |
display_name | string | ❌ No | Returns schemes whose display name contains this text. |
archived | integer | ❌ No | Set to 1 to return archived schemes, 0 for active schemes. Defaults to active. |
editor_version | string | ❌ No | Filter by editor version. Values: V1.0 (Classic), V1.1 (Plasma), V2.0 (Photon). |
Response fields
| Field | Type | Description |
|---|---|---|
uuid | string | Unique identifier for the scheme. Use this in recommendation API calls. |
name | string | Internal name of the scheme. |
display_name | string | Human-readable name shown in the Blueshift app. |
description | string | Optional description of the scheme's purpose. May be null. |
editor_version | string | Algorithm editor version: V1.0 (Classic), V1.1 (Plasma), or V2.0 (Photon). |
is_plasma | boolean | Whether the scheme was built with the Plasma editor. |
archived | boolean | Whether the scheme is archived. |
author | string | Full name of the user who created the scheme. |
email | string | Email address of the user who created the scheme. |
created_at | string | Timestamp when the scheme was created, in ISO 8601 format. |
updated_at | string | Timestamp when the scheme was last updated, in ISO 8601 format. |
templates | array | Templates that use this scheme. Empty when none do. |
Template object
| Field | Type | Description |
|---|---|---|
name | string | Name of the template. |
uuid | string | UUID of the template. |
resource_type | string | Template type, for example EmailTemplate, PushTemplate, or WhatsappTemplate. |
archived | boolean | Whether the template is archived. |
Example requests & responses
List all schemes
curl --request GET \
--url https://api.getblueshift.com/api/v1/account_algorithms.json \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'[
{
"name": "BSFT_Curated_Items",
"display_name": "BSFT Curated Items",
"created_at": "2025-06-16T06:06:45.000Z",
"updated_at": "2026-03-27T18:43:15.000Z",
"uuid": "d449299a-4449-45f7-8762-d571667a32ed",
"archived": false,
"description": null,
"editor_version": "V2.0",
"author": "Jane Doe",
"email": "[email protected]",
"is_plasma": false,
"templates": []
},
{
"name": "curated_test",
"display_name": "curated test",
"created_at": "2026-03-27T18:45:06.000Z",
"updated_at": "2026-03-27T18:46:13.000Z",
"uuid": "7f61d116-c38b-4313-bd60-5c8867aa0e87",
"archived": false,
"description": "Curated products for the spring campaign",
"editor_version": "V2.0",
"author": "John Smith",
"email": "[email protected]",
"is_plasma": false,
"templates": [
{
"name": "Spring Promo Email",
"uuid": "79335089-07cc-44b7-8513-54fd41fb3875",
"resource_type": "EmailTemplate",
"archived": false
}
]
}
]Paginate through schemes
curl --request GET \
--url 'https://api.getblueshift.com/api/v1/account_algorithms.json?page=0&per_page=25' \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'{
"total_count": 468,
"total_pages": 19,
"per_page": 25,
"page": 0,
"results": [
{
"name": "BSFT_Curated_Items",
"display_name": "BSFT Curated Items",
"created_at": "2025-06-16T06:06:45.000Z",
"updated_at": "2026-03-27T18:43:15.000Z",
"uuid": "d449299a-4449-45f7-8762-d571667a32ed",
"archived": false,
"description": null,
"editor_version": "V2.0",
"author": "Jane Doe",
"email": "[email protected]",
"is_plasma": false,
"templates": []
}
]
}Search by display name
curl --request GET \
--url 'https://api.getblueshift.com/api/v1/account_algorithms.json?display_name=curated' \
--header 'accept: application/json' \
--header 'authorization: Basic <YOUR_API_KEY>'[
{
"name": "curated_test",
"display_name": "curated test",
"created_at": "2026-03-27T18:45:06.000Z",
"updated_at": "2026-03-27T18:46:13.000Z",
"uuid": "7f61d116-c38b-4313-bd60-5c8867aa0e87",
"archived": false,
"description": "Curated products for the spring campaign",
"editor_version": "V2.0",
"author": "John Smith",
"email": "[email protected]",
"is_plasma": false,
"templates": []
}
]