Records for a client
list_client_recordsFetch every onboarding record for a client ID, including statuses, steps, costs, IDs and dates; optionally include contact email and perform URL.
Instructions
Every record (onboarding request) sent to one client, with status, the steps it contains (type, completion, cost, check/document/form IDs) and dates. Uses GET /clients/{id}/records. The record's contact email and perform URL only with include_contact_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | API page number to start from (1-based, as documented; use next_page from a previous call) | |
| client_id | Yes | Client ID (a positive whole number) | |
| max_results | No | Most records to return in this call; whole API pages only (up to 100 per page), so fewer may come back with a next_page to continue from | |
| include_contact_details | No | Include each record's contact email and perform URL, and stop redacting emails, phone numbers, dates, postcodes and NI/NHS numbers in names, references and step preferences. Off by default. |