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 guide →
System
getMeDescribe the calling API key
Returns the identity, team and effective scopes of the key making the request. Scope-free: every integration can call it.
https://api.mailneo.co/api/v2
GET
/meNo scope requiredExample request
curl "https://api.mailneo.co/api/v2/me" \ -H "X-API-Key: $MAILNEO_API_KEY"
Authorization
- Required scope
- None. Every key may call this endpoint.
- Credential
X-API-Key: mk_live_...Authorization: Bearer mk_live_...
Response · 200
Success
data
| Field | Type | Always present | Notes |
|---|---|---|---|
| object | "api_key" | "oauth_token" | Yes | |
| id | string | Yes | |
| key_id | string | Yes | |
| environment | "LIVE" | "TEST" | Yes | |
| team | object | Yes | |
| team.id | string | Yes | |
| role | string | Yes | |
| role_at_issue | string | Yes | |
| client | object | No | |
| client.id | string | Yes | |
| client.name | string | Yes | |
| client.grant_id | string | Yes | |
| client.resource | string | Yes | |
| api_version | string | Yes | |
| scopes | string[] | Yes | |
| granted_scopes | string[] | Yes |
meta
| Field | Type | Always present | Notes |
|---|---|---|---|
| request_id | string | Yes |
System
getUsageRead current-period usage and limits
Lets an automation self-throttle against its own quota instead of discovering the ceiling by hitting a 402.
https://api.mailneo.co/api/v2
GET
/usageNo scope requiredExample request
curl "https://api.mailneo.co/api/v2/usage" \ -H "X-API-Key: $MAILNEO_API_KEY"
Authorization
- Required scope
- None. Every key may call this endpoint.
- Credential
X-API-Key: mk_live_...Authorization: Bearer mk_live_...
Response · 200
Success
data
| Field | Type | Always present | Notes |
|---|---|---|---|
| object | "usage" | Yes | |
| period | object | Yes | |
| period.start | string | Yes | |
| period.end | string | Yes | |
| plan | string | Yes | |
| contacts | object | Yes | |
| contacts.used | number | Yes | |
| contacts.limit | number | Yes | |
| emails | object | Yes | |
| emails.used | number | Yes | |
| emails.limit | number | Yes | |
| api | object | Yes | |
| api.requests_per_minute | number | Yes | |
| api.max_keys | number | Yes | |
| api.send_allowed | boolean | Yes |
meta
| Field | Type | Always present | Notes |
|---|---|---|---|
| request_id | string | Yes |