list_users gives (name, email, role, currencies, status); the
company summary covers name, package, available currencies, creation date, and
the connected integrations as id + name + type. Pass your own role id to
get_role to read the permissions behind your limits.
access carries one key per resource you can actually reach
(statement, request, quota, data_table): how broadly you see it
(scope plus a plain-language description) and, for statements and
requests, the saved views you may pass to the matching list tool. Each view
also carries access — the roles and users who can read it — when you are
allowed to share that resource. A resource you have no access to carries no
key at all — if a key is missing, do not try to query that resource. Reports
never carry one — call list_reports to discover the ones shared with you.
Takes no arguments: the identity is read from the authenticated session, not
passed in. For the full profile (managers, groups, plan attributions, custom
attributes), call get_user with your own name or id.
Response
Body
Body
object
Show object properties
Show object properties
string
string
Deep link to open this user in the Qobra web app.
string
string
string
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.object
string
Currency the user is actually paid in. One of:
AED, AFN, ALL,
AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT,
BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN,
BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP,
COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD,
EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP,
GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR,
ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS,
KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR,
LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK,
MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD,
NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP,
PKR, PLN, PYG, QAR, RMB, RON, RSD, RUB, RWF, SAR,
SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD,
SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD,
TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF, VND,
VUV, WON, WST, XAF, XAG, XAU, XCD, XOF, XPD, XPF,
XPT, XSU, YER, ZAR, ZMK, ZWL.string
Currency the user’s commissions are computed in. One of:
AED, AFN,
ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD,
BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD,
BTN, BWP, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY,
COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP,
DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS,
GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF,
IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES,
KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP,
LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD,
MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN,
NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK,
PHP, PKR, PLN, PYG, QAR, RMB, RON, RSD, RUB, RWF,
SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD,
STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY,
TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VEF,
VND, VUV, WON, WST, XAF, XAG, XAU, XCD, XOF, XPD,
XPF, XPT, XSU, YER, ZAR, ZMK, ZWL.boolean
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.
boolean
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.
object[]
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.
string
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.
object
Show object properties
Show object properties
string
string
string
The company’s Qobra subscription tier: core, advanced, scale, or others.
Some features depend on it. One of:
core, advanced, scale,
others.string[]
object[]
string
object
Show object properties
Show object properties
object
Show object properties
Show object properties
string
One of:
all, users_below, me, shared.string
Plain-language sentence about what this scope actually lets you
reach for this resource, meant to be read as-is.
object[]
The saved views you may pass as the
view_id argument of this
resource’s list tool. Each view carries its own access roster —
roles and users who can read it — populated when you may share the
resource, null otherwise.Show object properties
Show object properties
string
string
object
Who can read this view, split into roles and users, each with
the level they hold. Only the tools that list views for you to
choose between resolve it — list_quotas, list_data_tables and
get_identity — and only for callers who may share the resource.
Null everywhere else, so null is silence about the roster
(either not asked for, or not yours to see), never an empty one:
a caller who may see it and finds nobody gets empty
roles and
users instead.Show object properties
Show object properties
object[]
Show object properties
Show object properties
string
The level this role holds on the whole resource
category, which reaches every view of it without a share
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role only got this view through
a share. One of: read, write, delete.string
The level granted to this role on this view specifically
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role reaches the view through
its category access rather than a share. One of: read,
write, delete.object[]
Show object properties
Show object properties
string
The level this view is shared with the user at,
individually, on top of whatever their role already
grants —
read (view it), write (edit and re-share
it) or delete (also remove it), each level including
the ones before it. One of: read, write, delete.object
Show object properties
Show object properties
string
One of:
all, users_below, me, shared.string
Plain-language sentence about what this scope actually lets you
reach for this resource, meant to be read as-is.
object[]
The saved views you may pass as the
view_id argument of this
resource’s list tool. Each view carries its own access roster —
roles and users who can read it — populated when you may share the
resource, null otherwise.Show object properties
Show object properties
string
string
object
Who can read this view, split into roles and users, each with
the level they hold. Only the tools that list views for you to
choose between resolve it — list_quotas, list_data_tables and
get_identity — and only for callers who may share the resource.
Null everywhere else, so null is silence about the roster
(either not asked for, or not yours to see), never an empty one:
a caller who may see it and finds nobody gets empty
roles and
users instead.Show object properties
Show object properties
object[]
Show object properties
Show object properties
string
The level this role holds on the whole resource
category, which reaches every view of it without a share
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role only got this view through
a share. One of: read, write, delete.string
The level granted to this role on this view specifically
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role reaches the view through
its category access rather than a share. One of: read,
write, delete.object[]
Show object properties
Show object properties
string
The level this view is shared with the user at,
individually, on top of whatever their role already
grants —
read (view it), write (edit and re-share
it) or delete (also remove it), each level including
the ones before it. One of: read, write, delete.object
Show object properties
Show object properties
string
One of:
all, users_below, me, shared.string
Plain-language sentence about what this scope actually lets you
reach for this resource, meant to be read as-is.
object[]
The saved views you may pass as the
view_id argument of this
resource’s list tool. Each view carries its own access roster —
roles and users who can read it — populated when you may share the
resource, null otherwise.Show object properties
Show object properties
string
string
object
Who can read this view, split into roles and users, each with
the level they hold. Only the tools that list views for you to
choose between resolve it — list_quotas, list_data_tables and
get_identity — and only for callers who may share the resource.
Null everywhere else, so null is silence about the roster
(either not asked for, or not yours to see), never an empty one:
a caller who may see it and finds nobody gets empty
roles and
users instead.Show object properties
Show object properties
object[]
Show object properties
Show object properties
string
The level this role holds on the whole resource
category, which reaches every view of it without a share
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role only got this view through
a share. One of: read, write, delete.string
The level granted to this role on this view specifically
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role reaches the view through
its category access rather than a share. One of: read,
write, delete.object[]
Show object properties
Show object properties
string
The level this view is shared with the user at,
individually, on top of whatever their role already
grants —
read (view it), write (edit and re-share
it) or delete (also remove it), each level including
the ones before it. One of: read, write, delete.object
Show object properties
Show object properties
string
One of:
all, users_below, me, shared.string
Plain-language sentence about what this scope actually lets you
reach for this resource, meant to be read as-is.
object[]
The saved views you may pass as the
view_id argument of this
resource’s list tool. Each view carries its own access roster —
roles and users who can read it — populated when you may share the
resource, null otherwise.Show object properties
Show object properties
string
string
object
Who can read this view, split into roles and users, each with
the level they hold. Only the tools that list views for you to
choose between resolve it — list_quotas, list_data_tables and
get_identity — and only for callers who may share the resource.
Null everywhere else, so null is silence about the roster
(either not asked for, or not yours to see), never an empty one:
a caller who may see it and finds nobody gets empty
roles and
users instead.Show object properties
Show object properties
object[]
Show object properties
Show object properties
string
The level this role holds on the whole resource
category, which reaches every view of it without a share
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role only got this view through
a share. One of: read, write, delete.string
The level granted to this role on this view specifically
—
read (view it), write (edit and re-share it) or
delete (also remove it), each level including the ones
before it. Null when the role reaches the view through
its category access rather than a share. One of: read,
write, delete.object[]
Show object properties
Show object properties
string
The level this view is shared with the user at,
individually, on top of whatever their role already
grants —
read (view it), write (edit and re-share
it) or delete (also remove it), each level including
the ones before it. One of: read, write, delete.