Skip to main content
GET
/
receivables
/
{receivable_id}
/
mails
/
{mail_id}
Get a mail sent by receivable
curl --request GET \
  --url https://api.sandbox.monite.com/v1/receivables/{receivable_id}/mails/{mail_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "recipients": {
    "bcc": [
      {
        "email": "jsmith@example.com",
        "is_success": true,
        "error": "<string>"
      }
    ],
    "cc": [
      {
        "email": "jsmith@example.com",
        "is_success": true,
        "error": "<string>"
      }
    ],
    "to": [
      {
        "email": "jsmith@example.com",
        "is_success": true,
        "error": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-monite-version
string<date>
required
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

receivable_id
string<uuid>
required
mail_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required

The time the mail task was created

updated_at
string<date-time>
required

The time the mail task was updated

status
enum<string>
required

The status of the mail sent by receivable

Available options:
pending,
processing,
sent,
partially_sent,
failed
recipients
object