List document requests
Document Requests
List Document Requests
Retrieve a paginated list of all document requests belonging to you.
GET
List document requests
Retrieve a paginated list of all document requests created by your organisation. 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. If you receive a
403 with request.organisations.module.not-enabled, contact your organisation admin to have it activated. Learn more.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
limitandoffsetto manage large result sets.
Best Practices
- Monitor Status: Regularly list
pendingrequests to track completion rates and identify customers who may need a follow-up. - Expiration Tracking: Identify requests approaching their
expires_atdate to ensure document collection is completed in time. - Efficiency: Use a
limitof 100 for background reporting and 20-50 for user-facing dashboards.
Authorizations
Query Parameters
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})$Available options:
pending, completed, expired Available options:
asc, desc Response
List of document requests retrieved successfully