Retrieve Email Log

Beta

GET/v1/core/email-logs/{id}

This endpoint is idempotent. Learn more

Returns an email log by ID.

Permissions requiredValues:email_logs:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Email log ID.

include[]optional arrayenumValues:sent_by

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Email log ID.

objectstringenumValues:email_log

Resource type identifier.

send_statusstringenumValues:sentpending

Whether the email was handed off to the delivery provider.

sent: the provider accepted the email for delivery. It does not confirm that the recipient's mail server accepted it.
pending: the email was never handed off — the send attempt failed, or it was suppressed because the account is in sandbox mode.

recipientsarray of string

Recipient email addresses.

subjectstringnullable

Email subject line.

filenamestringnullable

Filename of the document attached to the email.

sent_byactorExpandablenullable

The user or API key that sent the email.

Emails the platform sends automatically, such as system notifications, are not attributed to an actor.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

user: a human user account.
api_key: a programmatic caller authenticating with an API key.
agent: an automated agent acting on the account's behalf.
group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.

namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

For user actors: the user's email address.
For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

rolerolenullable

The role the actor holds in the account, which determines what it is permitted to do.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Email Log

Retrieve Email Log

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailLog = await client.core.emailLogs.retrieve('eml_h2j1q1nfibwb');

console.log(emailLog.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const emailLog = await client.core.emailLogs.retrieve('eml_h2j1q1nfibwb');

console.log(emailLog.id);

200 example

{
  "id": "eml_h2j1q1nfibwb",
  "object": "email_log",
  "send_status": "sent",
  "recipients": [
    "customer@example.com"
  ],
  "subject": "Order Confirmation #1001",
  "filename": "invoice_1001.pdf",
  "sent_by": {
    "id": "us_43irtlt2ajz6",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@openmrp.ai",
    "avatar_url": "https://cdn.openmrp.ai/avatars/us_43irtlt2ajz6.jpg",
    "role": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "eml_h2j1q1nfibwb",
  "object": "email_log",
  "send_status": "sent",
  "recipients": [
    "customer@example.com"
  ],
  "subject": "Order Confirmation #1001",
  "filename": "invoice_1001.pdf",
  "sent_by": {
    "id": "us_43irtlt2ajz6",
    "object": "actor",
    "type": "user",
    "name": "John Doe",
    "handle": "jdoe@openmrp.ai",
    "avatar_url": "https://cdn.openmrp.ai/avatars/us_43irtlt2ajz6.jpg",
    "role": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Email Log

Authorization

Path Parameters

Query Parameters

Returns

Responses