Skip to content

Email Logs

Operations Summary

Method Endpoint Description
GET /api/email-logs/ List Email Logs
GET /api/email-logs/{uuid}/ Retrieve

List Email Logs

1
2
3
4
http \
  GET \
  https://api.example.com/api/email-logs/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.email_logs import email_logs_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = email_logs_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: email_logs_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { emailLogsList } from 'waldur-js-client';

try {
  const response = await emailLogsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
body string
emails string
o array Ordering
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
sent_at string (date)
subject string

200 -

The response body is an array of objects, where each object has the following structure:

Field Type
uuid string (uuid)
url string (uri)
sent_at string (date-time)
subject string
body string
emails array of string (email)s

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/email-logs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.email_logs import email_logs_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = email_logs_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: email_logs_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { emailLogsRetrieve } from 'waldur-js-client';

try {
  const response = await emailLogsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type
uuid string (uuid)
url string (uri)
sent_at string (date-time)
subject string
body string
emails array of string (email)s