API Reference

List reports

get
https://api.kalepa.com/external/reports

Retrieve a paginated list of reports, optionally filtered by creation, effective, received or last-updated dates, terminal state, a submission identifier, or org group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date-time

Filter reports created on or after this date.

date-time

Filter reports created on or before this date.

date-time

Filters reports that were last updated after the specified date.

date-time

Filters reports that were last updated before the specified date.

date-time

Filters reports that have a proposed effective date before the specified date.

date-time

Filters reports that have a proposed effective date after the specified date.

date-time

Filters reports that were received after the specified date.

date-time

Filters reports that were received before the specified date.

boolean

Filters reports that are terminal (or not-terminal).

boolean

Flag indicating whether to include shells in the response.

int32
≥ 1

the page number to fetch

int32
≤ 500
Defaults to 100

the number of items per page (max 500)

string

Filters reports by a specific submission identifier, such as an external ID or quote number.

string
enum

The type of submission identifier to filter by. Exactly one of submission_identifier and submission_identifier_type must be supplied together.

Allowed:
string

Filters reports by a specific org group.

boolean
Defaults to false

Include deleted reports in the response.

Responses

400

The request is invalid.

401

The bearer token is missing or invalid.

403

The authenticated client is not permitted to access this resource (e.g. insufficient permissions or org-group scope).

500

An unexpected error occurred.

Updated about 2 months ago

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

Updated about 2 months ago