Mail API reference

Mail API · Limits

get/v1/workspaces/{workspace_id}/limitsAuth

Get the workspace send limits

The send limits per minute, per hour and per day (each recipient counts one), what is used and left in each window now, and when each resets. Limits follow the workspace plan (Free 60 / 600 / 10,000; Pro 300 / 5,000 / 25,000; Scale 600 / 10,000 / 50,000); `custom` is true when ProductCraft set different limits for this workspace. A send over a limit is refused with 429 `RATE_LIMITED`, `Retry-After` and `ratelimit-*` headers; successful sends carry the same `ratelimit-*` headers. Reading this changes nothing and counts nothing.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200

plan*object

The plan the limits come from; null when the plan is not known (the Free limits apply).

Example: "pro"

custom*boolean

True when ProductCraft set limits for this workspace that differ from its plan.

Example: false

windows*array

Per minute, per hour and per day.

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/limits
Authorization: Bearer YOUR_TOKEN

Response

{
  "plan": "pro",
  "custom": false,
  "windows": [
    {
      "window": "per_minute",
      "limit": 60,
      "used": 12,
      "remaining": 48,
      "reset_seconds": 41
    }
  ]
}