Skip to main content
GET
/
api
/
invoices
/
{invoice_uid}
/
outreach
Get outreach timeline for one invoice
curl --request GET \
  --url https://dev.exante.app/api/invoices/{invoice_uid}/outreach \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "status_code": 200,
  "message": "Success",
  "data": {
    "invoice": {
      "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "target_party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "counterparty_name": "<string>",
      "amount_due_cents": 123,
      "currency": "<string>",
      "status": "<string>",
      "issue_date": "2023-11-07T05:31:56Z",
      "due_date": "2023-11-07T05:31:56Z",
      "paid_date": "2023-11-07T05:31:56Z"
    },
    "emails": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "initiator": {
          "type": "<string>",
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        },
        "from_email": "<string>",
        "to_emails": [
          "<string>"
        ],
        "cc_emails": [
          "<string>"
        ],
        "subject": "<string>",
        "body_text": "<string>",
        "status": "<string>",
        "delivery_status": "<string>",
        "bounce_details": {},
        "is_bounced": true,
        "bounce_callout": {
          "source": "<string>",
          "detected_at": "<string>",
          "recipient_emails": [
            "<string>"
          ]
        },
        "bouncing_recipient_emails": [
          "<string>"
        ],
        "error_message": "<string>",
        "sent_at": "2023-11-07T05:31:56Z",
        "planned_send_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "bouncing_recipient_emails": [
      "<string>"
    ]
  }
}
Returns the full outbound email timeline for a single invoice.

Includes

  • invoice header details (invoice_number, amount due, status, dates, counterparty)
  • chronological outbound timeline (most recent first)
  • polymorphic initiator data (AGENT or USER) with resolved name
  • delivery and bounce metadata (delivery_status, bounce_details)
  • explicit bounce callouts:
    • is_bounced
    • bounce_callout.source
    • bounce_callout.detected_at
    • bounce_callout.recipient_emails
    • bouncing_recipient_emails (at both email-level and top-level aggregate list)

Authorization behavior

The endpoint is organization-scoped.
  • If organization_uid is omitted, the API uses your default organization.
  • If organization_uid is invalid, the API returns 400.
  • If you are not a member of the requested organization, the API returns 403.
  • If the invoice does not exist in the caller’s organization, the API returns 404.

Authorizations

Authorization
string
header
required

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

Path Parameters

invoice_uid
string<uuid>
required

Query Parameters

organization_uid
string<uuid>

Response

Invoice outreach timeline

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
Example:

"Success"

data
object