list

HTTP Request

GET /api/v1/organizations/:organizationName/reports

GET /api/v1/institutions/:institutionName/reports

Path parameters

Parameter
Type
Description

organizationName

string

The name of the organization

institutionName

string

The name of the institution

Query parameters

Parameter
Type
Description

maxResults

integer

Maximum number of results to return. Defaults to 100, may not exceed 1000.

pageToken

string

Page token, returned by a previous call, to request the next page of results. If not provided, the first page will be returned

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.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of report resources.

{
    "kind": "reportList",
    "nextPageToken": integer,
    "results": [
        object(report.list)
    ]
}

Examples

curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/organizations/my_organization/reports"

Last updated

Was this helpful?