Skip to main content
Return who you are acting as, your company and what you can reach. Call it first. The caller is returned as the same compact row list_users gives (name, email, role, currencies, status), plus your own language and timezone, which say how to answer you and appear here and nowhere else. For your full profile (managers, groups, plan attributions, custom attributes), call get_user with your own id. Pass your own role id to get_role to read the permissions behind your limits. The company is deliberately minimal: id, name and the fiscal calendar. Read the fiscal calendar before interpreting any period label. Every YYYY, YYYY-SX and YYYY-QX label another tool returns is numbered on it, and the company’s own fiscal year need not start in January. A response of FY2027, 2026-02 → 2027-01 says the current fiscal year is FY2027 and spans February 2026 through January 2027. For the rest of the configuration (statement periods, currencies, the AI agents your company runs, which optional modules are switched on), call get_company_settings. For the connected integrations, call list_integrations. access carries one key per resource you can reach: statement, request, quota, data_table, report, dashboard. A missing key means you have no access, or the company has the feature off: do not query that resource. Each key has a scope, a plain-language description and, for statements and requests, the saved views you may pass as view_id to the matching list tool. The scopes are:
  • all: everything.
  • users_below: you and everyone below you, for statements only.
  • me: your own statements, or the requests you are a member of.
  • shared: no default access, only what is shared with you.
A view’s own access lists who can read it through a share, when you may share that resource; the roles that reach every view through their access to the whole category are listed once on the resource, as category_roles. A caller who reaches a report only through a shared dashboard carries no report key. shared_resources names the resources shared with you individually, the grants that reach past your role, already counted in access above. Pass your own role id to get_role for the other channel: what is shared with everyone holding your role. The rows follow the same shape get_role returns. Sharing is a live-environment concept, so those are the live ones. Takes no arguments: the identity is read from the authenticated session, not passed in.

​
Response

Body

​
object
Same compact fields as each item in list_users’s response (id, resource_url, name, email, status, role, manager, payment_currency, calculation_currency, licensed, license_missing, integrations, last_synced_at), plus two fields unique to this tool:
​
object
​
object
One key per resource you can actually reach (statement, request, quota, data_table, report, dashboard): 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. category_roles lists once per resource the roles that reach every view through their category access; each view’s access.roles keeps only the roles it is shared with. category_roles is null when no roster is resolved. A resource you have no access to carries no key at all. Full per-resource schema: Access object reference.
​
object[]
Resources shared with you individually, on top of your role’s access: access already counts them (get_role with your role id gives the role’s own shares). Empty when none. Full field reference (resource, resource_type, parent_name, access): get_role’s shared_resources, same shape. Live environment only.