Get domain details

GET

/api/domains/{domain}

const url = 'https://smtp-app.kirim.email/api/domains/example.com';
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/domains/example.com \
  --header 'Authorization: Basic <credentials>'

Retrieve details of a specific domain

Authorizations

basicAuth

Parameters

Path Parameters

domain

required

string

Example

example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Responses

200

Successfully retrieved domain details including verification status and configuration

application/json

object

success

Indicates if the request was successful

boolean

data

Domain object containing email domain configuration and verification status

object

Unique identifier for the domain

integer

domain

Domain name used for sending emails

string

tracklink_domain

Custom tracking domain for click and open tracking

string

tracklink_domain_is_verified

Whether the tracking domain has been verified

boolean

auth_domain_is_verified

Whether the authentication domain has been verified

boolean

dns_selector

DKIM selector used for DNS verification

string

dns_record

DKIM public key record that should be configured in DNS

string

click_track

Whether click tracking is enabled for emails sent from this domain

boolean

open_track

Whether open tracking is enabled for emails sent from this domain

boolean

unsub_track

Whether unsubscribe tracking is enabled for emails sent from this domain

boolean

is_verified

Whether the domain has been verified for email sending

boolean

status

Domain status (active/inactive)

boolean

created_at

Unix timestamp when the domain was created

integer

modified_at

Unix timestamp when the domain was last modified

integer

spf_record

Expected SPF record value that should be configured in DNS

string

Example

{
  "success": true,
  "data": {
    "id": 1,
    "domain": "example.com",
    "tracklink_domain": "",
    "tracklink_domain_is_verified": false,
    "auth_domain_is_verified": false,
    "dns_selector": "k1",
    "dns_record": "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjF2J8K5xqH7N8Z9L2zQ3bX9Y1tW7vU6kR5aP4sT8nB3mV7cZ2jX5L8oR9pN3tQ1wE4vY6bF2aC8hI7gD5eJ9kL3mX8oQ6bH2nV5pZ9cR8tW7yB4mX6qN5zL3oV8cF2tH9nB5pQ7eZ1mX8sT6kR4vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQ2tK4nB5pL1mX8sT6kR9vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQ2tK4nB5pL1mX8sT6kR9vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQIDAQAB",
    "click_track": false,
    "open_track": false,
    "unsub_track": false,
    "is_verified": false,
    "status": true,
    "created_at": 1762810896,
    "modified_at": 1762810896,
    "spf_record": "v=spf1 mx include:spf.kirim.email ~all"
  }
}

401

Unauthorized

application/json

object

error

Error type indicating authentication failure

string

message

Human-readable error message explaining the authentication issue

string

Example

{
  "error": "Unauthorized",
  "message": "Authorization header is required"
}

404

Domain not found

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Domain not found"
}

429

Too Many Requests - Rate limit exceeded. Retry after the specified time.

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

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