List delivery logs

Overview

Returns a paginated log of all email/webhook delivery attempts for the company, newest first, filterable by type, status, recipient, and date range.

Prerequisites

A bearer token. Callable with Partner and Account tokens.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/account/white-label/email-templates/logs

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Partner and Account tokens.
Authentication plus an email-template feature check.
company_id is scoped by an ownership check.
Only the reachable companies differ per role.

Rate limit

No rate limit.

Request body

Body:

Field	Type	Required	Description
`company_id`	integer	Yes	Must be an existing account inside your own account tree.
`type`	string	No	nullable. Filter by `EmailTemplateType` value.
`status`	string	No	nullable. One of `pending`, `sent`, `failed`, `skipped`.
`recipient`	string	No	nullable, `max:255`. Partial email LIKE match.
`date_from`	string (date)	No	nullable. Include records with `created_at` >= this date.
`date_to`	string (date)	No	nullable. Include records with `created_at` <= this date.
`per_page`	integer	No	nullable; 10–100 (values below 10 are raised to 10). Defaults to 25.

{
  "company_id": 1,
  "type": "user_welcome",
  "status": "sent",
  "recipient": "jane@",
  "date_from": "2024-06-01",
  "date_to": "2024-06-30",
  "per_page": 25
}

Response

data.status (string) — success.
data.data (object) — paginator: current_page, data (array of log rows), first_page_url, from, last_page, last_page_url, links, next_page_url, path, per_page, prev_page_url, to, total.
Each log row carries id, partner_company_id, store_id, template_type, recipient_email, delivery_method, status, skip_reason, error_message, subject, payload_json, response_json, webhook_delivery_id, message_id, sent_at, created_at, updated_at.

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "current_page": 1,
      "data": [
        {
          "id": 412,
          "partner_company_id": 1,
          "store_id": null,
          "template_type": "user_welcome",
          "recipient_email": "[email protected]",
          "delivery_method": "email",
          "status": "sent",
          "skip_reason": null,
          "error_message": null,
          "subject": "Welcome aboard, Jane!",
          "payload_json": null,
          "response_json": null,
          "webhook_delivery_id": null,
          "message_id": null,
          "sent_at": "2026-06-23T09:14:02.000000Z",
          "created_at": "2026-06-23T09:14:01.000000Z",
          "updated_at": "2026-06-23T09:14:02.000000Z"
        },
        {
          "id": 410,
          "partner_company_id": 1,
          "store_id": null,
          "template_type": "account_disconnected",
          "recipient_email": "[email protected]",
          "delivery_method": "webhook",
          "status": "failed",
          "skip_reason": null,
          "error_message": "Webhook responded 500",
          "subject": "Action needed — your Google connection at Downtown Clinic",
          "payload_json": null,
          "response_json": null,
          "webhook_delivery_id": null,
          "message_id": null,
          "sent_at": null,
          "created_at": "2026-06-22T18:02:55.000000Z",
          "updated_at": "2026-06-22T18:02:56.000000Z"
        }
      ],
      "first_page_url": "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/logs?page=1",
      "from": 1,
      "last_page": 1,
      "last_page_url": "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/logs?page=1",
      "links": [
        {
          "url": null,
          "label": "&laquo; Previous",
          "active": false
        },
        {
          "url": "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/logs?page=1",
          "label": "1",
          "active": true
        },
        {
          "url": null,
          "label": "Next &raquo;",
          "active": false
        }
      ],
      "next_page_url": null,
      "path": "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/logs",
      "per_page": 25,
      "prev_page_url": null,
      "to": 2,
      "total": 2
    }
  }
}

422 Validation Error · `422`

{
  "message": "The selected status is invalid.",
  "errors": {
    "status": [
      "The selected status is invalid."
    ],
    "date_from": [
      "The date from field must be a valid date."
    ]
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	Validation Error
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/logs" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 1, "type": "user_welcome", "status": "sent", "recipient": "jane@", "date_from": "2024-06-01", "date_to": "2024-06-30", "per_page": 25}'

Updated 8 days ago

Did this page help you?