aYOUne
← CRM API

ImapMails

Singular: ImapMail — Base URL: https://crm-api.ayoune.app — Access: read-only

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e0b0a1121b7d48fe158489",
    "seen": false,
    "html": "default",
    "plain": "default",
    "subject": "",
    "labelIds": [],
    "attachments": [],
    "inReplyTo": [],
    "sent": false,
    "references": [],
    "done": false,
    "tags": [],
    "spam": false,
    "team": [],
    "editor": "6045f4d25704710012485569",
    "support": false,
    "createdBy": "6045f4d25704710012485569",
    "linkedAccounts": [],
    "createdAt": "2024-02-29T16:28:17.234Z",
    "updatedAt": "2024-02-29T16:28:17.234Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://crm-api.ayoune.app/imapmails/65e0b0a1121b7d48fe158489",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "MailAccounts",
        "title": "MODEL_MAILACCOUNT",
        "href": "https://api.ayoune.app/config/mailaccounts",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.mailaccounts"
      }
    ],
    "debugId": "6a62df76d98fe96440cc8f13",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_IMAPMAIL",
        "href": "https://api.ayoune.app/crm/imapmails/65e0b0a1121b7d48fe158489/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_IMAPMAIL",
        "href": "https://api.ayoune.app/crm/imapmails/65e0b0a1121b7d48fe158489/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.46.1",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2343",
      "reset": "1784868196",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 189.763735,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /imapmails List with filters/pagination crm.imapmails.view
GET /imapmails/:id Single record by ID crm.imapmails.view

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.crm.imapMails.find().limit(10).exec();

// Single record
const one = await ay.crm.imapMails.findById('OBJECT_ID').exec();

See also