List the users of your company alphabetically with filters and pagination; rows carry integration links and last HRIS sync for coverage checks.
List users of your company, with simple filters and pagination.Rows are ordered alphabetically by name (A→Z). Each row already carries the
user’s current direct manager, integration links and last HRIS sync. To group
users by manager, or to answer a sync-coverage question (“who is missing from
the HiBob sync?”), paginate this tool and read manager or integrations.
Never call get_user once per user. Reach for get_user only when you need one
user’s manager history, groups, plans or custom attributes.
Id of the manager whose team to narrow to — everyone below them in the
hierarchy (all levels, not just direct reports). The id list_users returns,
or the manager’s exact email.
With manager_id, keep only the people reporting directly to that manager,
not the levels below them. Requires manager_id; passing it alone returns
an input error. Defaults to false.
Row offset into the result set — the number of rows to skip before this
page. Any offset >= 0 is accepted; it does not have to be a multiple of
limit, so you can start from an arbitrary row. Pass the next_offset returned
by the previous call to walk the pages, or None for the first page.
User lifecycle state: pending (invited, not logged in yet), active,
inactive (deactivated), archived (has left the company; hidden by
default in list_users). One of: inactive, pending, active,
archived.
The user’s direct manager today; null when they report to no one. A
user has one manager at a time, so grouping users by manager takes one
paginated list_users, never a call per manager. get_user lists their
past managers with dates.
Whether the user holds a paid Qobra license (a seat). Only licensed
users have their compensations calculated and a statement to view — an
unlicensed user’s statement is never computed, which is the usual reason
someone ‘can’t see X’s statement’. A newly-arrived user typically needs
a license added; a departed user who no longer appears in the data is a
candidate for archiving to free their seat.
True when the user is NOT licensed yet has compensations that would
otherwise be calculated — the statement can’t be computed for lack of a
seat. This is what raises the red warning banner at the top of a
statement; resolve it by assigning the user a license.
The user’s links to the company’s connected integrations (HRIS, CRM…),
one entry per integration they are matched in. An empty list means the
user is matched in none — which is what ‘this user is missing from the
<integration> sync’ looks like. Use list_users to answer
sync-coverage questions over the whole company in one call; never call
get_user per user.
When this user’s identity was last refreshed from the HRIS integration.
Null means never synced — either the company has no HRIS connected, or
this user has never been matched in it.
