DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Workspace Item → List File Pages

AI-generated

Summary

Retrieve a paginated list of pages within a specific file in a DocuSign workspace folder.

Inputs

  • Authentication — Choose the authentication method to access the DocuSign API: OAuth2 or JWT (Service Integration). Defaults to OAuth2.
  • Category — Select the API category to interact with; for this operation, the context is Workspace Items under various categories, defaulting to 'envelopes'.
  • Account ID (required) — The DocuSign Account ID (GUID) to identify the account context.
  • Workspace ID (required) — The ID of the workspace containing the file.
  • Folder ID (required) — The ID of the folder within the workspace that contains the file.
  • File ID (required) — The ID of the file to list pages for.
  • Page Filters — Pagination parameters including 'Count' (number of pages to return, default 100) and 'Start Position' (starting index position, default 0).

Output shape

a list of page objects for the specified file within the workspace folder, optionally paginated based on the 'Page Filters' inputs

The response includes pagination controlled by 'Count' and 'Start Position' parameters. Requires the account, workspace, folder, and file identifiers to scope the query appropriately.

Examples

Example 1: List the first 50 pages of a file

Set Account ID, Workspace ID, Folder ID, File ID, and in Page Filters, set Count to 50 and Start Position to 0.

Links

Discussion