Get credential details

GET

/api/domains/{domain}/credentials/{credential}

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

Retrieve details of a specific SMTP credential

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.

credential

required

string format: uuid

Example

92703823-f3a4-48e2-8e87-7adf25454800

Credential GUID (user_smtp_guid)

Responses

200

Success

application/json

object

success

Indicates if the request was successful

boolean

data

SMTP credential object containing authentication details for email sending

object

Database auto-increment ID (internal use only)

integer

user_smtp_guid

Unique credential GUID used for API operations

string

username

SMTP username for authentication. Must be unique within the domain

string

created_at

Unix timestamp when the credential was created

integer

modified_at

Unix timestamp when the credential was last modified

integer

Example

{
  "success": true,
  "data": {
    "id": 1,
    "user_smtp_guid": "92703823-f3a4-48e2-8e87-7adf25454800",
    "username": "myuser",
    "created_at": 1640995200,
    "modified_at": 1640995200
  }
}

401

Unauthorized - Invalid or missing authentication credentials

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Unauthorized"
}

403

Forbidden - Credential does not belong to the specified domain

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Credential does not belong to the specified domain"
}

404

Credential not found

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Credential 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

500

Server Error - Unexpected error occurred

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "An error occurred while processing the request."
}