Companies¶
A company is the tenant boundary in a multi-tenant RTLS deployment. Most workflows operate within one company; cross-tenant access requires a company-admin user.
Operations¶
| Method | What it does |
|---|---|
client.companies.list() |
All companies visible to the current user. |
client.companies.get(uid) |
One company by uid (filters list() client-side; raises NotFound if absent). |
client.companies.create(name, **fields) |
Create a company. |
client.companies.update(uid, **fields) |
Update fields. |
client.companies.delete(uid) |
Delete. |
companies = client.companies.list()
co = client.companies.get(companies[0].uid)
new = client.companies.create(name="Acme Logistics")
get exists for convenience only — the server has no single-company
endpoint (a path GET 404s and the list ignores a uid filter), so it
fetches the visible companies and selects the match in the SDK.
Model — Company¶
| Field | Type | Notes |
|---|---|---|
uid |
str |
Server-assigned. Always present. |
name |
str |
Display name. Always present. |
user_params |
dict \| None |
Free-form tenant settings (color, role, tag_allocation, …). |
users |
Any \| None |
List of member-user summaries (varies by endpoint). |
projects |
Any \| None |
List of project summaries scoped to the company. |
See also¶
- Scope switching —
client.with_scope(company_uid=...)for cross-tenant work.