Skip to main content

List Sender Identities

Retrieve a paginated list of the sender identities available to your account.

Only identities that are enabled for sending are returned, so any identity in the response is safe to use as a campaign's from_identity. Results are ordered by email address.

Request

GET /sender-identities

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number (min: 1)
per_pageinteger100Items per page (min: 1, max: 100)

Example Request

curl -X GET "https://email.easy.tools/api/v1/sender-identities" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"

Response

Success Response (200 OK)

{
"data": [
{
"uuid": "8f14e45f-ceea-467a-9575-1a1b2c3d4e5f",
"email": "hello@acme.com",
"from_name": "Acme",
"reply_to": "support@acme.com"
}
],
"pagination": {
"current_page": 1,
"per_page": 100,
"total": 1
}
}

Response Fields

Each entry in data has the fields described in Sender Identity Object.

Pagination Object

FieldTypeDescription
current_pageintegerCurrent page number
per_pageintegerNumber of items per page
totalintegerTotal number of sender identities

Error Responses

Validation Error (422 Unprocessable Entity)

Returned when page or per_page is out of range.

{
"error": {
"code": "VALIDATION_ERROR",
"message": "The given data was invalid",
"details": {
"per_page": ["The per page field must not be greater than 100."]
}
}
}