v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Agent Organization

Get Organization

Returns the organization structure the caller belongs to.

Notes:

  • When the caller is part of a multi-team group (brokerage), orgType is MULTI_TEAM and multiTeamInfo carries the parent group's ID and name; enterpriseInfo is absent.
  • Otherwise orgType is SIGNAL_INSTANCE and enterpriseInfo describes the caller's office, visible sub-offices, and assigned permission profile.
  • visibleOrgInfoList depends on the caller's permissions: callers with MANAGE_ORGANIZATION see all offices in the company; callers with MANAGE_ORGANIZATION_DEPARTMENT see their own office's sub-offices; others receive an empty list.
get/v1.0/org

Headers

Authorizationstring required

Bearer [access_token]

Response

Organization info for the caller.

orgTypeinteger

Organization type