Actions35
- Account Actions
- Attachment Actions
- Bank Transaction Actions
- Bank Transfer Actions
- Contact Actions
- History and Note Actions
- Invoice Actions
- Manual Journal Actions
- Organisation Actions
- Report Actions
Organisation → Get Users
AI-generatedSummary
Retrieve a list of users within a specified organization in Xero, optionally filtered, sorted, and limited by modification date.
Inputs
- Organization Name or ID (required) — Select the organization by name or ID to fetch its user list.
- Options (optional) — Additional filters and sorting options, including:
- Custom Where clause to filter users by Xero API syntax.
- If-Modified-Since date to return only users updated since the timestamp.
- Order By field to sort results by specified user attributes.
- Sort Order to specify ascending or descending sorting.
- Where Filters to filter users by email address, first name, subscriber status, last name, or organisation role.
Output shape
a list of user objects belonging to the selected organization
Returned data includes users filtered by the provided criteria. Supports advanced filtering via custom where clauses and multiple fixed filter fields. Sorting and date based filtering are also supported.