SendlySendly
API ReferenceEmails

Get a single email

GET
/api/emails/{id}

Fetch one email together with its DELIVERY history — the transitions behind status, oldest first.

events here is not the custom-event resource: the events a caller records with POST /api/v1/events are read from GET /api/v1/events, and never appear on this response.

Requires the emails:read scope — View the emails you have sent and their delivery status.

Authorization

AuthorizationBearer <token>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": "string",
    "to": "string",
    "subject": "string",
    "status": "PENDING",
    "sentAt": "2019-08-24T14:15:22Z",
    "deliveredAt": "2019-08-24T14:15:22Z",
    "bouncedAt": "2019-08-24T14:15:22Z",
    "openedAt": "2019-08-24T14:15:22Z",
    "clickedAt": "2019-08-24T14:15:22Z",
    "complainedAt": "2019-08-24T14:15:22Z",
    "opens": 0,
    "clicks": 0,
    "tags": [
      "string"
    ],
    "error": "string",
    "failureKind": "provider_paused",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "events": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "PENDING",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    ]
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}
{
  "success": false,
  "error": {
    "message": "string",
    "code": "string",
    "details": {
      "errors": [
        null
      ]
    }
  }
}