Skip to main content
POST
Services Report
Generate a report of the services in your broker account. The endpoint sends the report to the specified email addresses. Spaces in the broker name become underscores. The attachment contains these columns:

Errors

Error responses use success: false and an error object.

Authorizations

Authorization
string
header
required

Send the API key in the Authorization bearer header. Production keys begin with sk_live_.

Body

application/json
recipients
string[]
required

Items are trimmed and lowercased; empty strings are ignored and duplicates are removed. Every remaining value must be an email address, and at most 10 unique nonempty recipients may remain.

Minimum array length: 1
status_filter
enum<string> | null
default:all

An omitted, null, or empty value applies the all filter.

Available options:
all,
active,
pending,
suspended,
cancelled,

Response

Report send attempts completed.

success
boolean
required
data
object
required
message
string
pagination
object
Last modified on August 2, 2026