List Reports

Get a paginated list of reports for your organisation. Use this to poll report generation status after requesting a report.

Required steps before calling:

  1. Obtain a JWT via POST /api/wp-crm/token

Security:

  • The organisationId in the URL path must match the organisation your JWT was issued for. The token is cryptographically bound to a specific organisation — requests targeting a different organisation will fail with 401 Unauthorized.
  • Only users with CRM_ADMIN or ACCOUNT_OWNER role in the organisation can list reports. Other roles will receive a 403 Forbidden.

Report statuses:

StatusMeaning
PENDINGReport is queued for generation
PROCESSINGReport is currently being generated
COMPLETEDReport is ready — use the download endpoint
FAILEDReport generation failed

Pagination: Use page and limit query parameters. Defaults to page 1, 10 items per page.

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

Your organisation UUID (returned as org from the /token endpoint)

Query Params
number
Defaults to 1

Page number

number
Defaults to 10

Items per page

Responses

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — user does not have CRM_ADMIN or ACCOUNT_OWNER role

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