Sender Identities

List sender identities

There is no separate "default" flag - the first item in the returned list is the default sender identity (used when an email doesn't specify one). Use POST .../set-default to change which one is first. Not paginated - always returns every identity on the project. Supports filter[<field>]=value exact-match filtering (e.g. filter[email]=support@example.com) to look one up directly instead of scanning the full list.

get/v1/projectId/{projectId}/sender-identities

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/sender-identities
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

Query parameters

filter[<field>]string

Exact-match filter on a top-level field, e.g. filter[email]=support@example.com. Repeatable for multiple fields.

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.