List records
list_recordsRetrieve and filter onboarding records by status, assignee, creator, and visibility, then sort by client name or date.
Instructions
Records (onboarding requests) across the team, each with status, the client's name and ID, its steps and dates. Filter by status, active/archived, creator, assignee (or unassigned), and the client's visibility; sort by client name or date. Uses GET /records.
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) | |
| status | No | Only records with this status (`status`) | |
| sort_by | No | Sort field (`sort_by`; created_at by default) | |
| assignee | No | Only records assigned to this team member's user ID, or false for unassigned records only (`assignee`) | |
| order_by | No | Sort direction (API parameter `order_by`; ascending by default) | |
| created_by | No | Only records created by this team member's user ID (`created_by`) | |
| visibility | No | Only active or only archived records (`visibility`; both by default) | |
| 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 | |
| client_visibility | No | Only records whose client is active, or archived (`client_visibility`) | |
| 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. |