List delivery logs

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

Auth: Both — authentication + an email-template feature check. company_id scoped by an ownership check. (Only the reachable companies differ per role.)

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerYesMust be an existing account inside your own account tree.
typestringNonullable. Filter by EmailTemplateType value.
statusstringNonullable. One of pending, sent, failed, skipped.
recipientstringNonullable, max:255. Partial email LIKE match.
date_fromstring (date)Nonullable. Include records with created_at >= this date.
date_tostring (date)Nonullable. Include records with created_at <= this date.
per_pageintegerNonullable; 10–100 (values below 10 are raised to 10). Defaults to 25.

Response{ data. } envelope with nested status + data, where data is a standard paginator of EmailDeliveryLog rows.

  • status (string) — success.
  • 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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
string
string
string
string
integer
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json