managers, groups and plans list every attribution whatever its dates, as
YYYY-MM windows; a null end or departure date means the attribution is still
ongoing. plans are the live environment’s.
Attribute values are rendered as the user holds them: amounts carry their
currency, dates are UTC instants, picklists render as labels and user
references as {id, email, name} objects rather than raw ids. An unset value
is null, except a bool, which reads false. For the schema behind them (each
attribute’s type, source and the labels a picklist accepts), call
list_user_attributes.
shared_resources is what reaches the user beyond their role: resources shared
with them individually. A user whose role denies a whole category can still
reach specific resources this way, so read it alongside
get_role on their role id before
concluding from the permissions alone. Sharing is a live-environment concept,
so those are the live ones.
Reading someone else’s shares is administrative information: rows for a
resource whose sharing you may not administer are dropped. Calling get_user
on yourself always returns your own shares in full.
Parameters
Body
Body
string
required
Id from list_users, or the user’s exact email.
Response
Body
Body
string
string
Deep link to open this user in the Qobra web app.
string
string
string
pending (invited, not logged in yet), active, inactive (deactivated) or
archived (has left the company). One of:
inactive, pending, active,
archived.object
The user’s permission role. Its id goes to get_role.
object
The direct manager today; null when none.
managers below lists past
managers with dates.string
Currency the user is 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 license (a paid seat). Only licensed users have
their compensations calculated: an unlicensed user’s statement is never
computed.
boolean
True when the user is unlicensed but has compensations that need a seat, so
the statement cannot be computed: the warning banner on a statement.
object[]
One link per connected integration (HRIS, CRM…) the user is matched in.
Empty means matched in none: missing from every sync.
string
When the user’s identity was last refreshed from the HRIS. Null: never
synced (no HRIS, or never matched in it).
object[]
object[]
object[]
object[]
Resources shared with this user individually, on top of their role’s access
(get_role covers the role’s own shares). Empty when none, or, for a user
other than you, when none concerns a resource whose sharing you may
administer. Live environment only.