Skip to content
Kirim.Email SMTP API

Get user domains

GET
/api/domains

Retrieve a paginated list of domains for authenticated user

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 10 >= 1 <= 100

Number of domains per page

page
integer
default: 1 >= 1

Page number

search
string

Search domains by name

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successfully retrieved paginated list of domains owned by the authenticated user

object
success

Indicates if the request was successful

boolean
Example
true
data

Array of domain objects for the authenticated user

Array<object>

Domain object containing email domain configuration and verification status

object
id

Unique identifier for the domain

integer
Example
1
domain

Domain name used for sending emails

string
Example
example.com
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
Example
k1
dns_record

DKIM public key record that should be configured in DNS

string
Example
v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDjF2J8K5xqH7N8Z9L2zQ3bX9Y1tW7vU6kR5aP4sT8nB3mV7cZ2jX5L8oR9pN3tQ1wE4vY6bF2aC8hI7gD5eJ9kL3mX8oQ6bH2nV5pZ9cR8tW7yB4mX6qN5zL3oV8cF2tH9nB5pQ7eZ1mX8sT6kR4vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQ2tK4nB5pL1mX8sT6kR9vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQ2tK4nB5pL1mX8sT6kR9vY9bH3mC8qI7gL5nX2oW9zF5pD8eB7hR3mX6yV9cQIDAQAB
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
Example
true
created_at

Unix timestamp when the domain was created

integer
Example
1762810896
modified_at

Unix timestamp when the domain was last modified

integer
Example
1762810896
spf_record

Expected SPF record value that should be configured in DNS

string
Example
v=spf1 mx include:spf.kirim.email ~all
pagination

Pagination metadata for paginated API responses

object
total

Total number of items available across all pages

integer
Example
50
page

Current page number (1-based)

integer
Example
1
limit

Maximum number of items per page

integer
Example
10
offset

Number of items skipped from the beginning (0-based)

integer
0

401

Section titled “401 ”

Unauthorized

object
error

Error type indicating authentication failure

string
Example
Unauthorized
message

Human-readable error message explaining the authentication issue

string
Example
Authorization header is required

429

Section titled “429 ”

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

object
success
boolean
message
string
Example
Too many attempts. Please try again later.

Headers

Section titled “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