list_users

string

Words to find in the name or email: every word must appear, in any order, ignoring case and accents. Never matched against ids.

string

Only users in this status. Omit for active, inactive and pending users: archived ones are listed only when asked. One of: inactive, pending, active, archived.

string

Id from list_users, or exact email, of a manager: keeps everyone below them at every level, not the manager. The reporting lines as of today.

boolean

Keep only the manager’s direct reports, not the levels below. Refused without manager_id.

integer

Rows per page, 1 to 75. Default 25. A larger value is refused.

integer

Rows to skip. Omit it for the first page, never null or the string ‘None’; for the next page pass the previous next_offset.

object[]

Show object properties

string

Deep link to open this user in the Qobra web app.

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.

Show object properties

string

object

The direct manager today; null when none. get_user lists past managers with dates.

Show object properties

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.

Show object properties

object

The company connection this link belongs to.

Show object properties

string

The user’s id in the customer’s own system.

string

When the user’s identity was last refreshed from the HRIS. Null: never synced (no HRIS, or never matched in it).

integer

Qobra MCP server

Parameters

Response

​Parameters

​Response

Parameters

Response