Docs
System

Rate limit status

Get this key’s rate-limit status

Requests consumed and remaining in the current one-minute window, for the read (GET), write (POST/PATCH/PUT/DELETE) and bulk (batched endpoints) buckets, plus the plan tier being applied. This call itself counts toward the read bucket.

GET
/v2/workspaces/{workspaceId}/rate-limit

Path Parameters

workspaceIdnumber

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/rate-limit"
{
  "data": {
    "plan": "growth",
    "read": {
      "limit": 300,
      "used": 13,
      "remaining": 287
    },
    "write": {
      "limit": 300,
      "used": 13,
      "remaining": 287
    },
    "bulk": {
      "limit": 300,
      "used": 13,
      "remaining": 287
    },
    "resetsAt": 1741694400
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Health checkGET

API health check Unauthenticated liveness probe. Not rate limited, requires no API key.

Bulk email account statusPOST

Get status for up to 50 accounts in one call POST rather than GET because the id list can exceed a practical query-string length. Results are ordered to match the requested ids; ids that do not exist in this workspace are reported in `notFound` rather than failing the request.