Workspace Items

List File Pages

GET
/v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages

This method returns a workspace file as rasterized pages.

Authorization

OAuth2
AuthorizationBearer <token>

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

In: header

Path Parameters

accountId*string

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

fileId*string

The ID of the file.

folderId*string

The ID of the folder.

workspaceId*string

The ID of the workspace.

Query Parameters

count?string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

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.

start_position?string

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/workspaces/string/folders/string/files/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"}