REST API · v1

API overview

Base URL: https://www.mailofly.com/api/v1. Resource routes require Authorization: Bearer unless noted. Create keys in the app: API keys.

Authentication

Header: Authorization: Bearer <key>. Keys use the mf_live_ prefix. 401 when the key is missing, invalid, or expired.

Example header
Authorization: Bearer mf_live_…

Responses & errors

Successful reads typically return { "data": … }. Creates return 201 with data. Errors return 4xx/5xx with JSON such as:

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

Resources

GET/api/v1

List API resources

Returns JSON describing available resources and paths. Use this to discover what the server exposes. No authentication required.

Authentication: not required

Returns

FieldType
resourcesobject
cURL
curl -sS "https://www.mailofly.com/api/v1" \
  -H "Accept: application/json"

Requests use https://www.mailofly.com

No API key required for this endpoint.

Response

Try it sends the request through this app to https://www.mailofly.com (no browser CORS issues).

Click Try it to run the example against the live API.

Example responses

{
  "version": "1",
  "resources": { "accounts": "/api/v1/accounts", "contacts": "/api/v1/contacts" }
}
GET/api/v1