download

Overview

This endpoint is used to download the csv associated with a report, which was generated by an organization or institution administrator.

HTTP Request

GET /api/v1/reports/:reportReference/download

Path parameters

Parameter

reportReference

A qualified reference to the report, of the shape ownerName.reportIdentifier. See referencing resources for more information.

circle-info

This endpoint extends the general API structure

Authorization

You must be an administrator of the report's organization or institution, and your access token must have the following scope:

  • organization.read

Learn more about authorization.

Response body

The response body will contain the contents of the report as a CSV document.

Was this helpful?