List a policy's document renders

Retrieve the documents rendered for a policy, such as each policy schedule sent to the policyholder, including pending, failed and skipped renders. Only documents whose entity_type is policy are included. Use download a policy document render to fetch the PDF of a complete render. The total number of renders is returned in the X-Total-Count response header.

Documents are opt-in per organization: unless the org_documents feature flag is enabled for your organization this endpoint returns 404.

Path Params
string
required

Must be a UUID. The unique identifier of the policy.

Query Params
integer
1 to 100
Defaults to 30

The maximum number of items that will be contained in a single page, between 1 and 100 (inclusive).

integer
≥ 1
Defaults to 1

The page number of the entities to fetch. Must be a minimum of 1.

Responses

403

The caller is missing the communications:read permission.

404

No such policy (a policy outside the caller's user group counts as not found), or documents are not enabled for the organization.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json