Get All Reports

This endpoint retrieves a paginated list of pre-signed URLs, allowing authenticated customers to download their reports. To enable this feature, please contact the customer success team.

Functionality

The endpoint returns URLs that provide direct access to various report files. Each pre-signed URL remains accessible for 2 minutes after generation, ensuring secure access to customer-specific data. Files are automatically removed from the system 90 days after their creation.

Supported File Types

• .csv
• .html
• .json (detailed, inline)
• .json (simple)
• .pdf
• .png
• .txt
• .xlsx
• .zip

NOTE

Replace <base_url> from the examples below with one of the following:

Environment	Base URL
Production	https://api.cirrusmd.com
Sandbox	https://api-sandbox.cirrusmd.com

---

Request URL

GET <base_url>/customers/reports

Optional Query Parameters

Parameter	Description
start_after	Optional. Specifies where to start listing from. Use any key in the bucket; the last key is returned if more records are available. The start_after key should be used for paginated requests.
max_keys	Optional. Limits the number of files returned. Defaults to 25.

Example Request for getting Reports

curl "<base_url>/customers/reports"
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example Request for a Paginating list

curl "<base_url>/customers/reports?start_after=<start_after>"
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example Response

{
  "start_after": "customer/test.csv",
  "files": [
    {
      "name": "customer/test.csv",
      "url": "https://example.com/"
    }
  ]
}

Example Request for a max_key

curl "<base_url>/customers/reports?max_key=2"
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Example Response

{
  "start_after": "customer/test2.csv",
  "files": [
    {
      "name": "customer/test1.csv",
      "url": "https://example.com/"
    },
    {
      "name": "customer/test2.csv",
      "url": "https://example.com/"
    }
  ]
}