Skip to main content
GET
List document requests
Retrieve a paginated list of document requests. This endpoint supports filtering by status, searching by ID, and sorting options.
This endpoint requires the Document Requests feature to be enabled for your organisation. Without it, the API returns 403 with request.organisations.module.not-enabled. Learn more.

Permission

You see the document requests you created, or every document request in your organisation if you have organisation_cases:read or your organisation has shared cases enabled. An API key without organisation_cases:read receives an empty list, unless your organisation has shared cases enabled. See Permissions and API Keys.

Features

  • Filtering: Filter by request status (pending, completed, expired) or specific request ID.
  • Sorting: Order results by creation date to find newest requests first.
  • Pagination: Use limit and offset to manage large result sets.

Best Practices

  1. Monitor Status: Regularly list pending requests to track completion rates and identify customers who may need a follow-up.
  2. Expiration Tracking: Identify requests approaching their expires_at date to ensure document collection is completed in time.
  3. Efficiency: Use a limit of 100 for background reporting and 20-50 for user-facing dashboards.

Authorizations

x-api-key
string
header
required

Query Parameters

id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
status
enum<string>
Available options:
pending,
completed,
expired
limit
string
default:20
offset
string
default:0
sort_order
enum<string>
default:desc
Available options:
asc,
desc

Response

List of document requests retrieved successfully

total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
limit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991