List users
list_usersRead-onlyIdempotent
Fetch user records from a Timesheet Portal account, filtered by user ID, group code, or modification date; optionally include contact details.
Instructions
Users (GET /users): code, name, job title, role, employment type, group, home cost centre and line manager. Filters sent as documented: id (a single user), groupCode, ModifiedSince. Join and leave dates, the accounting code (which the spec says usually holds the payroll number), email, mobile, date of birth, gender, address and a limited-company contractor's company details only with include_contact_details. Bank details, national insurance and tax numbers, the payroll details in employmentDetails and HR personal details are never returned (includedFields is never sent).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | No | Only this user (sent as id; the docs say 'Return a single user specified by the id') | |
| max_pages | No | Maximum number of pages to fetch in this call (each page is one request against the 30-per-minute limit) | |
| group_code | No | Sent as groupCode | |
| start_page | No | Zero-based page to start from (next_page from a previous call) | |
| max_results | No | Most users to return in this call (default 100); the answer says how many were left out | |
| modified_since | No | ||
| include_contact_details | No | Include join and leave dates, accounting (payroll) code, email, mobile, date of birth, gender, title, home address and limited-company details, 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) |