Introduction

Welcome to the Mailry.co API documentation. This guide describes how to use our API to integrate Mailry.co services into your applications.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY

Base URL

All API endpoints are relative to the following base URL:

<https://api.mailry.co/ext>

GET Endpoints

Get All Emails

Retrieve a list of all emails in your account.

Endpoint: /ext/email

Method: GET

Query Parameters:

Parameter Type Description
page integer Page number (default: 1)
limit integer Number of items per page (default: 20, max: 100)
search string Search email address

Example Request:

curl -X GET "<https://api.mailry.co/ext/email>" \\
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response:

{
  "data": [
    {
      "id": "a3b1f5b2-6d0c-45f4-9d67-7c8b25e6d2f1",
      "createdAt": "2025-05-12T10:22:33.452Z",
      "updatedAt": "2025-05-12T10:22:33.452Z",
      "userId": "f2c1e9d4-3b5a-4978-bc7d-827a7a6f92b1",
      "domainId": "d4b8f3c2-6b9f-4e52-a7c4-72f1c0c1f27d",
      "avatar": null,
      "firstName": "john",
      "lastName": "doe",
      "email": "[email protected]",
      "storage": 1024,
      "status": 1,
      "isStandalone": false,
      "domain": {
        "id": "d4b8f3c2-6b9f-4e52-a7c4-72f1c0c1f27d",
        "createdAt": "2025-04-28T08:45:12.117Z",
        "updatedAt": "2025-04-28T08:45:12.117Z",
        "userId": null,
        "domainName": "example.mailry.app",
        "dkim": "default._domainkey.example.mailry.app",
        "dkimIdentifier": "default",
        "dkimStatus": true,
        "spf": "v=spf1 include:mailry.app ~all",
        "spfStatus": true,
        "mxStatus": true,
        "returnPathStatus": true,
        "status": "active"
      },
      "totalInbox": 7,
      "unreadInbox": 3
    },
    {
      "id": "c9f8e2a6-8f0b-44f7-9b5c-1e23b1a9e2c4",
      "createdAt": "2025-06-01T14:12:11.301Z",
      "updatedAt": "2025-06-01T14:12:11.301Z",
      "userId": "f2c1e9d4-3b5a-4978-bc7d-827a7a6f92b1",
      "domainId": "d4b8f3c2-6b9f-4e52-a7c4-72f1c0c1f27d",
      "avatar": null,
      "firstName": "jane",
      "lastName": "smith",
      "email": "[email protected]",
      "storage": 2048,
      "status": 1,
      "isStandalone": false,
      "domain": {
        "id": "d4b8f3c2-6b9f-4e52-a7c4-72f1c0c1f27d",
        "createdAt": "2025-04-28T08:45:12.117Z",
        "updatedAt": "2025-04-28T08:45:12.117Z",
        "userId": null,
        "domainName": "example.mailry.app",
        "dkim": "default._domainkey.example.mailry.app",
        "dkimIdentifier": "default",
        "dkimStatus": true,
        "spf": "v=spf1 include:mailry.app ~all",
        "spfStatus": true,
        "mxStatus": true,
        "returnPathStatus": true,
        "status": "active"
      },
      "totalInbox": 12,
      "unreadInbox": 5
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPage": 1,
    "totalData": 2
  },
  "status_code": 200,
  "message": "Success! Successfully getting emails."
}