Get logs for specific message in user domain

GET

/api/domains/{domain}/log/{message_guid}

const url = 'https://smtp-app.kirim.email/api/domains/example.com/log/550e8400-e29b-41d4-a716-446655440000';
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/log/550e8400-e29b-41d4-a716-446655440000 \
  --header 'Authorization: Basic <credentials>'

Retrieve all logs for a specific message in a domain owned by the authenticated user

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.

message_guid

required

string

Example

550e8400-e29b-41d4-a716-446655440000

Message GUID

Responses

200

Success

application/json

object

data

Array of log entries for the specific message in the user’s domain

Array<object>

Email log entry

object

Unique identifier for the log entry

string

user_guid

GUID of the user who sent the email

string

user_domain_guid

GUID of the domain used to send the email

string

event_type

Type of email event (sent, delivered, bounced, opened, clicked, etc.)

string

message_guid

Unique identifier for the email message

string

timestamp

Unix timestamp when the event occurred

integer

Example

{
  "data": [
    {
      "id": "log-id-123",
      "user_guid": "user-guid-123",
      "user_domain_guid": "domain-guid-456",
      "event_type": "delivered",
      "message_guid": "550e8400-e29b-41d4-a716-446655440000",
      "timestamp": 1640995200
    }
  ]
}

Headers

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window

400

Bad Request - User authentication missing

application/json

object

error

string

Example

{
  "error": "User authentication missing"
}

401

Unauthorized - Invalid or missing authentication

application/json

object

error

string

Example

{
  "error": "Unauthorized"
}

404

Not Found - Domain or log not found

application/json

object

error

string

Example

{
  "error": "Domain not found or you do not own this domain"
}

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

500

Server Error - Unexpected error occurred

application/json

object

error

string

Example

{
  "error": "Unknown error"
}