API at a glance

Description: This API retrieves all adapters configured in your Blueshift account for a specific channel. Adapters connect your account to third-party services (e.g., Mailgun for email, Infobip for SMS).

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

Channel required: Must specify a channel name to retrieve adapters.
Supported channels: Email, SMS, Push Message, Webhook, InApp, Segment Report.
Multiple adapters: You may have multiple adapters per channel.
Adapter filtering: Optionally filter by adapter name (e.g., sendgrid, sparkpost).
Use case: Best for auditing channel configurations, managing integrations, and retrieving adapter UUIDs for other API calls.

Request parameters

Check out the request parameters

Query parameters

Parameter	Type	Required	Description
`channel_name`	`string`	✅ Yes	Channel name: `Email`, `SMS`, `Push Message`, `Webhook`, `InApp`, or `Segment Report`.
`adapter_name`	`string`	❌ No	Filter by adapter name (e.g., `sendgrid`, `sparkpost`).

Example requests & responses

List all SMS adapters

GET /api/v1/account_adapters?channel_name=SMS

[
  {
    "id": 8147,
    "name": "46elks",
    "primary_name": "test-1",
    "uuid": "aafcf5a4-556f-4334-8cfc-4dfd2a61c691",
    "from_name": null,
    "from_address": null,
    "reply_to_address": null,
    "created_at": "2022-04-20T06:29:46.000Z",
    "updated_at": "2022-04-20T06:29:46.000Z",
    "is_active": false,
    "cname_record": null,
    "bypass_suppression_list": false,
    "channel": "Sms"
  },
  {
    "id": 8148,
    "name": "46elks",
    "primary_name": "test-2",
    "uuid": "dee6ea31-0456-49a8-8d7c-9e82b8d71cb8",
    "from_name": null,
    "from_address": null,
    "reply_to_address": null,
    "created_at": "2022-04-20T06:30:02.000Z",
    "updated_at": "2022-04-20T06:30:02.000Z",
    "is_active": false,
    "cname_record": null,
    "bypass_suppression_list": false,
    "channel": "Sms"
  }
]

Filter adapters by name

GET /api/v1/account_adapters?channel_name=SMS&adapter_name=46elks

[
  {
    "id": 8147,
    "name": "46elks",
    "primary_name": "test-1",
    "uuid": "aafcf5a4-556f-4334-8cfc-4dfd2a61c691",
    "from_name": null,
    "from_address": null,
    "reply_to_address": null,
    "created_at": "2022-04-20T06:29:46.000Z",
    "updated_at": "2022-04-20T06:29:46.000Z",
    "is_active": false,
    "cname_record": null,
    "bypass_suppression_list": false,
    "channel": "Sms"
  }
]