Email reports list

Returns a paginated list of the authenticated user's company email reports (recipient + cadence + targeted stores/accounts), with optional sorting and single-field search.

Auth: Both — authentication; under the role-agnostic account/* group (no bundle gate). The list is hard-scoped to the auth user's company, so a partner sees partner-level reports and an account user sees account-level reports for their own company. If the user has no company, the response is an empty collection.

Rate limit: No rate limit.

Request

  • Body (all optional):
FieldTypeRequiredNotes
sort_fieldstringnoOne of first_name, last_name, email, report_type, report_period_type_id.
sort_bystringnoasc/ASC/desc/DESC (defaults to ASC when sort_field set).
search_fieldstringnoOne of first_name, last_name, email, report_type, report_period_type_id, store_name.
search_valuestringnoFilter value (paired with search_field); NameNoAngleBrackets rule.
limitintegernoPage size, 10–100 (values below 10 are raised to 10); defaults to 10.

Response{ data. } envelope (paginated UserReport resource collection — data array plus links/meta pagination keys).

  • id (integer) — report id.
  • first_name (string|null) — recipient first name (from emails).
  • last_name (string|null) — recipient last name.
  • email (string|null) — recipient email.
  • report_type (string) — the report's report_type_id aliased as report_type.
  • report_period_type_id (string) — cadence period type id.
  • all_store (integer) — 0/1.
  • store_list (array) — objects { value: store_id, label: name [+ ' - ' + storeid] }.
  • account_list (array) — objects { value: company_id, label: company name }.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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