Email Identities

List verified sender identities used to send emails through Amazon SES.

GET/api/v1/email-identities

Get all email identities for the authenticated client. Cursor-paginated (per_page default 25, max 100; cursor for next/previous page). Filter with ?identity_status=verified|pending|failed.

Response Fields

idinteger

The identity ID.

uuidstring

The identity UUID.

emailstring

The verified sender email address.

namestring

The display name for this identity.

domainstring

The domain of the email address.

identity_statusstring

Verification status: pending, verifying, verified, or failed.

verified_atstring|null

ISO 8601 timestamp when the identity was verified.

created_atstring

ISO 8601 creation timestamp.

updated_atstring

ISO 8601 last update timestamp.

metaobject

Cursor pagination metadata (path, per_page, next_cursor, prev_cursor).

Request

curl -X GET \
  "https://byomailer.com/api/v1/email-identities" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Response

200

{
  "data": [
    {
      "id": 1,
      "uuid": "identity-uuid-1",
      "email": "[email protected]",
      "name": "Acme Inc",
      "domain": "example.com",
      "identity_status": "verified",
      "verified_at": "2024-01-15T10:30:00.000000Z",
      "created_at": "2024-01-10T08:00:00.000000Z",
      "updated_at": "2024-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "path": "https://byomailer.com/api/v1/email-identities",
    "per_page": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}

GET/api/v1/email-identities/{emailIdentityId}

Get a single email identity by ID.

Path Parameters

emailIdentityIdinteger

required

The identity ID.

Response Fields

idinteger

The identity ID.

uuidstring

The identity UUID.

emailstring

The verified sender email address.

namestring

The display name for this identity.

domainstring

The domain of the email address.

identity_statusstring

Verification status: pending, verifying, verified, or failed.

verified_atstring|null

ISO 8601 timestamp when the identity was verified.

created_atstring

ISO 8601 creation timestamp.

updated_atstring

ISO 8601 last update timestamp.

Request

curl -X GET \
  "https://byomailer.com/api/v1/email-identities/{emailIdentityId}" \
  -H "Authorization: Bearer {your-api-token}" \
  -H "Accept: application/json"

Response

200

{
  "data": {
    "id": 1,
    "uuid": "identity-uuid-1",
    "email": "[email protected]",
    "name": "Acme Inc",
    "domain": "example.com",
    "identity_status": "verified",
    "verified_at": "2024-01-15T10:30:00.000000Z",
    "created_at": "2024-01-10T08:00:00.000000Z",
    "updated_at": "2024-01-15T10:30:00.000000Z"
  }
}