Download Report

Get a presigned download URL for a completed report. The URL is a temporary S3 presigned link valid for a limited time.

Required steps before calling:

  1. Obtain a JWT via POST /api/wp-crm/token
  2. Request a report via POST /api/wp-crm/reports/:organisationId
  3. Poll GET /api/wp-crm/reports/:organisationId until status is COMPLETED
  4. Call this endpoint with the reportId to get the download URL

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 download reports. Other roles will receive a 403 Forbidden.

Behavior:

  • If the report is completed, returns a presigned S3 URL to download the CSV file.
  • If the report is still processing, returns HTTP 202 with the current status.
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)

string
required

The report UUID (from the create or list response)

Responses

202

Report is still processing

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