Organizations

Organizations allow collaborative management of their spaces by the users who are members.

To learn how to review the usage records of an organization, check the usage section.

Access: To manage an organization, you must be one of its members.

 

Fields

---

idstringrequired
The UUID of the organization. Is unique.
Format: string<uuid>
Example: 00000000-0000-0000-0000-000000000000

---

handlestringrequired
The handle of the organization. Is unique.
Format: string<handle>
Example: org-a

---

aliasstring | nullrequired
The alias of the organization.
Format: string,null<alias>
Example: Org A

---

membersintegerrequired
The number of members of the organization.
Format: integer<int32>
Example: 10

---

spacesintegerrequired
The number of spaces of the organization.
Format: integer<int32>
Example: 10

---

createdAtstringrequired
The date and time when the organization was created.
Format: string<date-time>
Example: 2023-01-01T00:00:00.000000Z

Org

{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "org-a",
  "alias": "Org A",
  "members": 10,
  "spaces": 10,
  "createdAt": "2023-01-01T00:00:00.000000Z"
}