List renders of a document

Retrieve the renders of a document across all policies and other entities, in the environment of the request. Filter by version or status, for example ?status=failed to find renders that need attention. The total number of matching renders is returned in the X-Total-Count response header.

An API key restricted to a user group gets 403 here, because this list spans every policy; it can list a policy's document renders instead.

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 document.

Query Params
uuid

Only return renders of this version of the document.

string
enum

Only return renders with this status.

Allowed:
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

400

Validation error, for example an unknown status.

403

The API key is restricted to a user group, or the caller is missing the communications:read permission.

404

No such document, 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