Report List

Use the Reports API to retrieve a list of reports available in your firm. This is useful for discovering report IDs needed by the Report Schedule and Generated Reports endpoints.

Overview


Base route	`/v1/reports`
Produces	JSON
Pagination	Yes
OAuth scopes	`REPORTS_READ`

📘
Access requirements
Access to reports.

Resource attributes

Attribute	Description
`report_id`	Integer -- The ID of the report. Example: `37`
`report_name`	String -- The name of the report. Example: `"Quarterly Performance Report"`
`created_on_date`	String -- Date the report was created. Format: `YYYY-MM-DD`. Example: `"2023-05-18"`
`last_update_date`	String -- Date the report was last updated. Format: `YYYY-MM-DD`. Example: `"2023-05-20"`
`num_associated_portfolios`	Integer -- Number of portfolio associations on the report. Example: `5`

Filter parameters

Parameter	Description
`filter[createdAfter]`	Returns reports created after the specified UTC timestamp. Example: `filter[createdAfter]=2017-04-06T20:12:45Z`
`filter[createdBefore]`	Returns reports created before the specified UTC timestamp. Example: `filter[createdBefore]=2017-04-06T20:12:45Z`
`filter[modifiedAfter]`	Returns reports modified after the specified UTC timestamp. Example: `filter[modifiedAfter]=2017-04-06T20:12:45Z`
`filter[modifiedBefore]`	Returns reports modified before the specified UTC timestamp. Example: `filter[modifiedBefore]=2017-04-06T20:12:45Z`
`filter[name]`	Returns reports containing the specified word or phrase. Example: `filter[name]=test`
`filter[entityId]`	Returns reports associated with the specified entity ID. Example: `filter[entityId]=12345`
`filter[groupId]`	Returns reports associated with the specified group ID. Example: `filter[groupId]=200`

Get all reports

Retrieves all reports within the authenticated user's firm.

GET /v1/reports

📘
Authentication
All requests require a base64-encoded API key pair:
Authorization: Basic {base64(key_id:key_secret)}
See Access & Authentication for setup.

curl -X GET "https://{firm}.addepar.com/api/v1/reports?filter[createdAfter]=2017-04-05T20:12:45Z&page[limit]=2&page[after]=2" \
  -H "Authorization: Basic {credentials}" \
  -H "Addepar-Firm: 1" \
  -H "Accept: application/vnd.api+json"

HTTP/1.1 200

{
  "data": [
    {
      "type": "reports",
      "id": "13",
      "attributes": {
        "report_id": 13,
        "report_name": "Billing Attributes Report",
        "created_on_date": "2017-05-24",
        "last_update_date": "2017-05-24",
        "num_associated_portfolios": 2
      },
      "links": {
        "self": "/v1/reports/13"
      }
    }
  ],
  "included": [],
  "links": {
    "next": "/v1/reports?page[limit]=2&page[after]=13"
  }
}

{
  "errors": [
    {
      "id": "forbidden",
      "status": "403",
      "title": "Forbidden",
      "detail": "Insufficient permissions. Required: access to reports."
    }
  ]
}

Response codes:

200 OK -- Success
400 Bad Request -- Incorrect or missing filter parameters
403 Forbidden -- Lacking reports permission
404 Not Found -- Entity or group not found

📘
Related resources

Report Schedules -- Manage automated report schedules.

Generated Reports -- Access completed report runs and download files.