List scheduled reports for a legal entity

List the scheduled reports generated for a legal entity on a single report date. Returns reports generated at legal entity level as well as those generated for the accounts beneath it, subject to your entitlements.

Legal-entity-level reports are only returned if you are entitled to every account in the entity.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

The entity ID of the legal entity to list reports for.

Query Params
int32
required
20150101 to 29999999

The report date to list reports for, matched against each report's report_date. This is the same field and the same filter behind the date picker on Studio's scheduled reports page, so a request for one date returns what that page shows for it.

What that date means depends on how the report was produced. For reports the analytics engine generates it is the last business date the data covers. For reports delivered as prepared files it is a label parsed out of the filename rather than a computed coverage end, and for a monthly file that label is the first calendar day of the month: a monthly billing summary for September 2026 is found at date=20260901, not at the month end. Treat report_date on a prepared file as an index key, not as a statement about coverage. Prepared files are exactly the reports for which period_type and the period dates are omitted.

A consequence worth planning for: because that label is a calendar day rather than a trading day, it can fall on a weekend or a holiday, and a client that walks business days alone will skip it. January is the reliable case — a monthly file for January is filed under the 1st, which is never a trading day — but any month whose 1st falls on a weekend behaves the same. Walk calendar days, or query the first of the month explicitly.

In neither case is it the date the report was produced or recorded. A report covering a business date is produced after that date closes, so filtering on when it appeared would answer with the preceding date's reports. When Clear Street recorded a report is reported separately on each one as generated_at, and a report regenerated later keeps the report_date it always had.

Exactly one date per request: date ranges are not supported, so fetch multiple days with one request per day.

category
array of objects

Restrict results to the given categories. Repeat the parameter to pass more than one. Omit to return every category.

category
file_format
array of objects

Restrict results to the given file formats. Repeat the parameter to pass more than one. Omit to return every format.

file_format
Allowed:
int32
1 to 1000
Defaults to 250

Number of reports to return per page.

string
length between 1 and 2048

Opaque cursor returned as next_page_token from a previous page. Omit to fetch the first page.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json