Skip to main content
GET
/
v1
/
emails
List emails
curl --request GET \
  --url https://api.mail.gorillaa.one/v1/emails \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromEmail": "<string>",
      "toEmails": [
        "<string>"
      ],
      "subject": "<string>",
      "status": "queued",
      "queuedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromName": "<string>",
      "ccEmails": [
        "<string>"
      ],
      "bccEmails": [
        "<string>"
      ],
      "replyTo": "<string>",
      "htmlBody": "<string>",
      "textBody": "<string>",
      "scheduledFor": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "deliveredAt": "2023-11-07T05:31:56Z",
      "bouncedAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "openCount": 123,
      "clickCount": 123,
      "tags": [
        "<string>"
      ],
      "metadata": {}
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your Gorillaa Mail API key as a Bearer token.

Example: Authorization: Bearer grl_live_xxxxxxxxxxxx

Keys prefixed grl_test_ operate in test mode with reduced limits.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
limit
integer
default:20
Required range: 1 <= x <= 100
​
status
enum<string>
Available options:
queued,
sending,
sent,
delivered,
bounced,
failed,
scheduled
​
tag
string
​
from
string<date-time>

Filter emails created after this ISO 8601 datetime

​
to
string<date-time>

Filter emails created before this ISO 8601 datetime

Response

Paginated list of emails

​
data
object[]
required
​
pagination
object
required