Mailneo
|Docs

Platform

System API

2 endpoints under https://api.mailneo.co/api/v2. Every request carries your key in the x-api-key header.

Start with the quickstart →

GET/me

Describe the calling API key

No scope required — every key may call this endpoint

Returns the identity, team and effective scopes of the key making the request. Scope-free: every integration can call it.

curl "https://api.mailneo.co/api/v2/me" \
  -H "x-api-key: $MAILNEO_API_KEY"
{
  "data": {
    "object": "api_key",
    "id": "c0z4f9y40zeevn30zoehc20zy",
    "key_id": "c1vfsn061vps8p51uvtfm81v5",
    "environment": "LIVE",
    "team": {
      "id": "c0z4f9y40zeevn30zoehc20zy"
    },
    "role": "MEMBER",
    "role_at_issue": "…",
    "client": {
      "id": "c0z4f9y40zeevn30zoehc20zy",
      "name": "Ada Lovelace",
      "grant_id": "c08sqlfr08iqzqs09cpstp092",
      "resource": "…"
    },
    "api_version": "2026-08-15",
    "scopes": [
      "contacts:read"
    ],
    "granted_scopes": [
      "contacts:read"
    ]
  },
  "meta": {
    "request_id": "6db8cde1-6cb8-4c4e-abb8-cabb6ab8c928"
  }
}
GET/usage

Read current-period usage and limits

No scope required — every key may call this endpoint

Lets an automation self-throttle against its own quota instead of discovering the ceiling by hitting a 402.

curl "https://api.mailneo.co/api/v2/usage" \
  -H "x-api-key: $MAILNEO_API_KEY"
{
  "data": {
    "object": "usage",
    "period": {
      "start": "2026-06-24T15:45:00.000Z",
      "end": "2026-06-24T15:45:00.000Z"
    },
    "plan": "…",
    "contacts": {
      "used": 4200,
      "limit": 25
    },
    "emails": {
      "used": 4200,
      "limit": 25
    },
    "api": {
      "requests_per_minute": 1,
      "max_keys": 10,
      "send_allowed": true
    }
  },
  "meta": {
    "request_id": "babad798-bbba-492b-acba-dabebdbadc51"
  }
}