Get a Transactional Mailing

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-reference.arta.io/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Arta API Reference MCP server": {
    "url": "https://api-reference.arta.io/mcp"
  }
}
Close
GET /transactional_mailings/{transactional_mailing_id}

Retrieve one of the notification emails Arta sent on your Organization's behalf.

A 404 answers an identifier that names no mailing this endpoint serves: one that is not well formed, one naming a mailing of another Organization, one naming a Live mailing read with a Test key or the reverse, one naming a notification type this endpoint does not serve, and one naming a mailing created more than 90 days ago.

This endpoint takes no query parameters and rejects any it is sent with a 400. Requires API access to be enabled for your Organization, and answers 403 otherwise.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

  • transactional_mailing_id string Required

    transactional_mailing_id parameter

Responses

  • 200 application/json

    Successful Transactional Mailing get response

    Hide headers attributes Show headers attributes
    • content-type string
    • x-arta-request-id string

      A unique identifier for the Arta API call

    Hide response attributes Show response attributes object
    • created_at string Required

      When Arta created the mailing, in UTC and without an offset.

    • email_rule_id integer | null Required

      The Email Rule that produced this mailing. Retrieve it with GET /email_rules/{email_rule_id}. null when no rule produced it, or when that rule has since been deleted.

    • email_subscription_id integer | null Required

      The Email Subscription that produced this mailing. Retrieve it with GET /email_subscriptions/{email_subscription_id}. null when no subscription produced it, or when that subscription has since been deleted.

    • id string(uuid) Required

      The mailing's identifier.

    • recipients array[object] Required

      Who the mailing was addressed to, in the order Arta addressed them.

      Hide recipients attributes Show recipients attributes object
      • email_address string Required

        The address the mailing was sent to.

      • name string | null Required

        The name Arta addressed, when one was known.

    • request_id string(uuid) | null Required

      The Request this mailing was sent about, if any.

    • sent_at string | null Required

      When Arta sent the mailing, in UTC and without an offset. null until it is sent, so a date clause on this field returns only mailings already sent, and sent_at:null returns the rest.

    • shipment_id string(uuid) | null Required

      The Shipment this mailing was sent about, if any.

    • status string | null Required

      How far the mailing got. sending: the mailing is being sent. accepted: the mailing was sent and its delivery has not been confirmed yet. delivered: the recipient's mail server accepted it — only this value means the mailing reached them. failed: the mailing could not be delivered. The status reflects the latest outcome reported for the mailing, so a failed mailing can still become delivered. null means no outcome has been recorded: the send is still under way or did not complete. status:null returns these mailings.

      Values are accepted, delivered, failed, sending, or null.

    • type string Required

      The notification this mailing carried. The values are the id fields of GET /metadata/email_notifications.
  • 400 application/json

    Bad Request

    Hide headers attributes Show headers attributes
    • content-type string
    • x-arta-request-id string

      A unique identifier for the Arta API call

    Hide response attribute Show response attribute object
    • error string Required

      What was at fault in the request.
  • 403 application/json

    Forbidden

  • 404 application/json

    Not Found

    Hide headers attributes Show headers attributes
    • content-type string
    • x-arta-request-id string

      A unique identifier for the Arta API call

    Hide response attribute Show response attribute object
    • errors object
      Hide errors attribute Show errors attribute object
      • detail string
GET /transactional_mailings/{transactional_mailing_id} 
curl \
 --request GET 'https://api.arta.io/transactional_mailings/{transactional_mailing_id}' \
 --header "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "created_at": "2026-09-20T15:23:10.482113",
  "email_rule_id": 1942,
  "email_subscription_id": 317,
  "id": "e25f02f6-44b1-47ab-8fb5-e5fcc6e3b754",
  "recipients": [
    {
      "email_address": "gallery@example.com",
      "name": "Gallery"
    }
  ],
  "request_id": "f5c8652b-7b23-4370-ac61-a474ccdad3db",
  "sent_at": "2026-09-20T15:23:11.000000",
  "shipment_id": "93604c50-8fd5-4953-adfe-922d3baf41ab",
  "status": "failed",
  "type": "self_ship_label"
}
Response examples (400) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "error": "filter is not a supported parameter"
}
Response examples (404) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}