Organization

TagmeClientAdvanced.get_current_organization_id() → str

Get organization id which is currently used by client.

Returns current organization id.

TagmeClientAdvanced.get_full_organization(organization_id: str, with_employees: bool | None = None, ) → FullOrganization

Get information about organization by id.

Parameters

* organization_id – organization id.

* with_employees – include information about employees.

Returns

information about organization.

TagmeClientAdvanced.get_full_organizations(query: str | None = None, page: int | None = None, size: int | None = None, org_ids: List[str] | None = None, ignore_org: bool | None = None, ) → List[FullOrganization]

Get information about organizations.

Parameters

* query – search query to filter organizations.

* page – page number for pagination. Defaults to None.

* size – page size for pagination. Defaults to None.

* org_ids – list of organization IDs to filter organizations. Defaults to None.

* ignore_org – whether to ignore organizations. Defaults to None.

Returns

list of organizations.

TagmeClientAdvanced.get_organization(org_key: str | None = None, ) → Organization

Get organization by id or name. If organization_id is None, get current organization.

Parameters org_key – id or name of organization.

Returns

organization found or current organization.

TagmeClientAdvanced.get_organizations() → List[Organization]

Get available organizations.

Returns list of organizations.

TagmeClientAdvanced.set_organization(org_key: str | None, ) → None

Set current organization which is used by client.

Parameters org_key – organization id or name. If set to None, sets first organization which was found.

TagmeClientAdvanced.update_organization(organization_id: str, name: str | None = None, config: OrganizationConfig | None = None, ) → FullOrganization