get_company_settings - Qobra public API documentation

Return how your company is configured, one block per settings section: profile (timezone, fiscal calendar), statements, currencies, ai (agent rollout) and the optional modules requests, validation_workflow, draws, licences. Reach for this when the question is about the setup rather than the figures (“are draws on?”, “who can use the Sales Coach?”, “who approves our statements?”), and to tell a feature that is switched off from a tool that simply came back empty. get_identity already carries the fiscal calendar; the profile block repeats it so the sheet reads on its own. The timezone and currency here are the company’s: yours are on the user of get_identity. For exchange rates, call list_exchange_rates. requests.topics lists the topic ids that create_request and update_request file a request under. A block with a settings_url names the settings page it is edited on, so an answer about a setting can point at where to change it. statements and draws have none: only Qobra support changes them. An optional module that is unusable is null, not a block of falsy fields. unavailable_modules gives the reason for each (the subscription tier does not include it, it is included but switched off, or, for licences only, you may not read it) and a remedy, the sentence to tell the user. When the tier is the reason, read package for the tier the company is on. None of them is a reason to retry. Some blocks also depend on your own permissions:

licences is null without the subscription permission.
ai lists pilot_users only if you may read the AI settings.
validation_workflow.templates is null if you may not read workflow templates. No row in unavailable_modules covers this, so do not report workflows as missing.

Takes no arguments: the company is the one your session is scoped to.

Response

Body

object

Show object properties

string

The company’s Qobra subscription tier: core, advanced, scale, or others. What a tier includes is why a module below may be absent — see unavailable_modules. One of: core, advanced, scale, others.

object

Always present.

Show object properties

string

IANA timezone the company’s dates are expressed in.

object

Same shape as on get_identity: the fiscal year in progress, as a plain month range. Repeated here so the sheet reads on its own.

Show object properties

string

The fiscal year label the current calendar day falls in, formatted like FY2027.

string

First month of the fiscal year, YYYY-MM.

string

Last month of the fiscal year, YYYY-MM.

string

Deep link to the company settings page.

object

Always present.

Show object properties

string

YYYY-MM; earliest period the statement navigation offers. A display floor: earlier statements can exist and list_statements returns them if asked. Null: no floor.

integer

Periods ahead of the current one where statements are calculated.

integer

Hour (0-23, UTC) of the automatic statement recalculation.

string

Always null: these are set by Qobra, not on a settings page. Ask Qobra support to change them.

object

Always present.

Show object properties

string

The company’s own currency. 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 commissions may be computed in a currency other than the payment one: the multi-currency feature and the company’s own switch.

string[]

Currencies the company has exchange rates for (list_exchange_rates). Empty when it has defined none.

string

Deep link to the currencies settings page.

object

Always present. One row per AI agent Qobra ships.

Show object properties

object[]

Show object properties

string

sales_coach (explains a rep their statement), analyst (answers reporting questions and builds reports), architect (builds compensation plans), mcp (the Qobra MCP server). One of: sales_coach, analyst, architect, mcp.

string

Deep link to this agent’s settings page.

boolean

Whether the agent is usable in this company: the subscription feature and the company’s AI switches. False is why nobody can use it.

boolean

Whether you may use the agent: available, narrowed by the pilot users in pilot mode. On mcp alone it can be true while available is false, for an account exempt from the company’s MCP switch.

string

all (everyone) or pilot (only pilot_users). One of: pilot, all.

object[]

The users allowed in pilot mode. Empty when mode is all, and when you may not read the company’s AI settings (your own available_to_you is unaffected).

Show object properties

string

Deep link to the AI settings page.

object

Null when requests are unusable — see unavailable_modules.

Show object properties

object[]

Topics a request can be filed under: the id goes to create_request and update_request. Empty when none is defined.

Show object properties

string

Deep link to the requests settings page.

object

Null when the approval workflow is unusable — see unavailable_modules.

Show object properties

object[]

The workflows statements can be assigned. Null when you may not read them: it does not mean none exist.

Show object properties

string

object[]

Stages in the order a statement goes through them.

Show object properties

boolean

Whether the stage gates what follows: until it is approved, the statement cannot be paid and the later stages wait. An optional stage blocks neither payment nor the later stages, but it still waits behind an earlier mandatory stage that is not approved yet.

boolean

True: every approver must approve. False: the first approval completes the stage.

object[]

The named users who approve this stage on every statement.

Show object properties

string

string[]

Approvers resolved per statement: statement_user (its user), manager_level_1 to manager_level_4 (that user’s manager, then the manager’s manager, and so on).

string

Deep link to the validation-workflow settings page.

object

Null when draws are unusable — see unavailable_modules.

Show object properties

string

Always null: draws are switched on by Qobra, not on a settings page. Ask Qobra support to modify this.

object

Null when seats are unusable, or when you may not read the company’s subscription — see unavailable_modules.

Show object properties

boolean

Whether seats are enforced: only a licensed user’s commissions are computed.

integer

How many seats the company has been granted.

string

Deep link to the subscription settings page.

object[]

One row per null block above, saying why it is null and what would bring it back. Empty when every module is available to you.

Show object properties

string

The null block: requests, draws, validation_workflow (statement approval) or licences (seats). One of: requests, draws, validation_workflow, licences.

string

not_in_package (the tier does not include it), switched_off (included, not turned on), not_yours_to_read (only licences: it may be on, you lack the permission). One of: not_in_package, switched_off, not_yours_to_read.

string

What to tell the user: a package upgrade, a settings change or a word to Qobra support.