MailcrateDocs
Sender identities

List sender identities

GET
/public/sender-identity

Requires the sender-identity:read scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Query Parameters

query?string
filter?unknown
status?string
Value in"subscribed""unsubscribed"
limit?integer
Range1 <= value <= 500
Default50
offset?integer
Range0 <= value
Default0
page?integer
Range1 <= value
sortBy?string
sortOrder?string
Value in"ASC""DESC"

Response Body

A page of results.

application/json
  1. response
data*array<>
total*integer

Matches across all pages.

limit*integer
offset*integer

The offset actually applied, also when you paginated with page.

Example Request
curl -X GET 'https://api.mailcrate.io/public/sender-identity' \  -H 'Authorization: Api-Key <api_key>'
Example Response
{  "data": [    {      "id": "string",      "name": "string",      "email": "string",      "status": "failed",      "created": "2019-08-24T14:15:22Z",      "updated": "2019-08-24T14:15:22Z",      "sendingDomainId": "string",      "lastVerificationCheck": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Check a sender identity's verification POST

Requires the `sender-identity:write` scope.

Send a batch of emails POST

Sends up to 500 messages in one request, each shaped exactly like a single send. Messages are processed in order and independently: one that fails (unknown template, unverified sender, suppressed recipient) is reported in its own result entry and the others still go out. A structurally invalid payload is rejected as a whole with `400` before anything is sent. Requires the `sending:write` scope.