Templates

Returns document page images based on input

GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages

Returns images of the pages in a template document for display based on the parameters that you specify.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

(Required) The external account number (int) or account ID GUID.

documentId*string

(Required) The ID of the document.

templateId*string

(Required) The ID of the template.

Query Parameters

count?string

The maximum number of results to return.

dpi?string

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

max_height?string

Sets the maximum height of the returned images in pixels.

max_width?string

Sets the maximum width of the returned images in pixels.

nocache?string

When true, using cache is disabled and image information is retrieved from a database. True is the default value.

show_changes?string

When true, changes display in the user interface.

start_position?string

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/templates/string/documents/string/pages"
{  "endPosition": "string",  "nextUri": "string",  "pages": [    {      "dpi": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "height": "string",      "imageBytes": "string",      "mimeType": "string",      "pageId": "string",      "sequence": "string",      "width": "string"    }  ],  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}