Retrieve sending limits for one address

GET/api/v1/domains/{domain}/limits/{email}

Requires anorganization API keywith the scopedomains:read

Parameters

Name	In	Type	Description
`domain`required	path	string	The domain id, or the domain name itself.
`email`required	path	string	The email identifier.

Request

GET/api/v1/domains/{domain}/limits/{email}

curl -X GET 'https://app.mailyte.com/api/v1/domains/yourdomain.com/limits/ada@example.com' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/domains/yourdomain.com/limits/ada@example.com', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/domains/yourdomain.com/limits/ada@example.com",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/domains/yourdomain.com/limits/ada@example.com');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/domains/yourdomain.com/limits/ada@example.com")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- objectstringlimits
- subjectstringdomain | mailbox
  What these limits are about.
- identifierstring
  The domain name, or the mailbox address.
- sending_rateobject
  Sending limits and how much of each is used. Null when the mail server could not be reached.
  - limitsobject
    Messages allowed per window. In each field, 0 means no limit and null means unknown.
    - hourlyinteger
      Messages allowed per hour. 0 means no limit; null means unknown.
    - dailyinteger
      Messages allowed per day. 0 means no limit; null means unknown.
    - monthlyinteger
      Messages allowed per calendar month. 0 means no limit; null means unknown.
    - burstinteger
      Messages allowed per burst. 0 means no limit; null means unknown. This one is configured but not enforced on sends.
  - usedobject
    Messages sent so far in each window. Subtract from limits for what is left. Null means unknown.
    - hourlyinteger
      Messages sent this hour. Null means unknown. Do not rely on 0 alone for billing or throttling.
    - dailyinteger
      Messages sent today. Null means unknown. Do not rely on 0 alone for billing or throttling.
    - monthlyinteger
      Messages sent this calendar month. Null means unknown. Do not rely on 0 alone for billing or throttling.
- storageobject
  Stored mail. Null when neither usage nor quota could be read.
  - used_bytesinteger
    Bytes stored now. Null means unknown; 0 means empty.
  - quota_bytesinteger
    Bytes allowed. Null with message_size present means no limit; null with message_size also null means unknown. (Here no limit is null, unlike sending_rate.limits, where it is 0.)
  - messagesinteger
    Messages stored. Null means unknown; 0 means empty.
- message_sizeobject
  Size limits per message, applied at delivery. Null when the mail server could not be reached.
  - max_message_bytesinteger
    The largest message allowed, in bytes. Null means no limit.
  - max_attachment_bytesinteger
    The largest attachment allowed, in bytes. Null means no limit.

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.