List clients
list_clientsRetrieve client records from Timesheet Portal with codes, categories, cost centres, currency, payment terms, and invoicing settings. Filter by client, category, cost centre, or modified date.
Instructions
Clients (GET /clients) with code, name, category, cost centre, currency, payment terms, invoicing settings and notes. Filters sent as documented: id (a client code), costCentreCode, clientCategoryCode, ModifiedSince. Addresses, billing name and email, tax and company numbers only with include_contact_details (which also sends include=address,billing).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_pages | No | Maximum number of pages to fetch in this call (each page is one request against the 30-per-minute limit) | |
| start_page | No | Zero-based page to start from (next_page from a previous call) | |
| client_code | No | Only this client (sent as id) | |
| max_results | No | Most clients to return in this call (default 100); the answer says how many were left out | |
| category_code | No | Sent as clientCategoryCode | |
| modified_since | No | ||
| cost_centre_code | No | ||
| include_contact_details | No | Include client addresses, billing name, billing email, tax number and company registration number, and stop redacting email addresses, phone numbers, national insurance numbers and UK postcodes typed into names and other text (bank and card numbers are always removed) |