Get user quota information

GET

/api/quota

const url = 'https://smtp-app.kirim.email/api/quota';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://smtp-app.kirim.email/api/quota \
  --header 'Authorization: Basic <credentials>'

Retrieve current quota information including current usage and maximum allowed quota for the authenticated user.

Authorizations

basicAuth

Responses

200

Quota information retrieved successfully

application/json

object

success

Request status

boolean

data

object

current_quota

Current available quota (aggregate + update)

integer

max_quota

Maximum allowed quota (aggregate limit)

integer

usage_percentage

Percentage of quota used ((max - current) / max * 100)

number format: float

Example

{
  "success": true,
  "data": {
    "current_quota": 850,
    "max_quota": 1000,
    "usage_percentage": 15
  }
}

401

Unauthorized - Invalid or missing API credentials

application/json

object

success

Public API Controller for Quota Management

Handles public-facing quota-related API requests.

boolean

message

string

Example

{
  "success": false,
  "message": "Unauthorized - User not authenticated"
}

404

User not found or has no quota configured

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "User quota not found"
}

429

Too many requests - Rate limit exceeded

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many requests"
}

Headers

Retry-After

integer

Seconds until rate limit resets

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window

500

Internal server error

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Internal server error"
}