API reference

Published reports

GET/PublishedReports/{id}

REST onlyFull license only

Returns the reports published to a client's Secure Communication Portal (SCP). Download each report with GET /Documents/{documentID}.

Parameters

Filter by the last days, or by a startDate / endDate range. With no filter, all published reports are returned.

Name	In	Type		Description
`id`	path	integer	required	Client id. `0` is not supported on this endpoint.
`days`	query	integer	optional	Reports published in the last n days.
`startDate`	query	integer	optional	Start of the publication date range, `YYYYMMDD`. Requires `endDate`.
`endDate`	query	integer	optional	End of the publication date range, `YYYYMMDD`. Requires `startDate` and must not be earlier than it.
`tenantId`	query	string	optional	Tenant to query, from `/Tenants`. Default: your user's main tenant.

Field	Type	Description
`name`	string	Report name, set by the publisher in CPA or SCP.
`location`	string	SCP folder the report is published in.
`publicationDate`	string	Publication date.
`reportDate`	string	Report date, set by the publisher.
`expirationDate`	string	Expiration date, set by the publisher.
`comments`	string \| null	Description or comments from the publisher.
`documentID`	string	Document id. Pass it to `GET /Documents/{documentId}` to download the file.

Status	Body
`400`	`"The user does not have access to this client or the client does not exist."` Also returned for `id=0`.
`400`	`"Both start and end date should be provided"`
`400`	`"Invalid date format. Please provide date in yyyyMMdd format"`
`400`	`"Start date should be less than end date"`
`400`	`"The user does not have access to this tenant or the tenant does not exist."`

Plus the common 401 and 429 responses. See Errors.