Organizations
List organizations the caller belongs to
objectstringrequireddataarrayrequiredShow child attributes
idstringrequirednamestringnullabletypestringrequiredrolestringrequiredcreatedAtstring · date-timerequiredCreate a new organization
Creates an organization owned by the caller (who becomes its admin). The name is required, cannot be "Personal", and cannot duplicate the name of an organization the caller already belongs to.
namestringrequiredidstringrequirednamestringnullabletypestringrequiredrolestringrequiredcreatedAtstring · date-timerequiredList organization members
Returns the active members of the organization. The caller must be a member of the organization.
idstringrequiredobjectstringrequireddataarrayrequiredShow child attributes
userstring · uuidrequiredemailstring · emailrequirednamestringnullablerolestringrequiredjoinedAtstring · date-timerequiredRename an organization
Renames the organization. Admin only. Not available for the Personal organization, nor to API keys. The name cannot be blank, cannot be "Personal", and cannot be the name of another organization the caller belongs to.
idstringrequirednamestringrequiredidstringrequirednamestringnullabletypestringrequiredrolestringrequiredcreatedAtstring · date-timerequiredDelete an organization
Deletes the organization. Its members and API keys can no longer use it. Admin only, and only once the caller is its sole member; refused while a plan still renews (a plan already set to cancel at period end does not block) or a device is still allocated. Not available for the Personal organization, nor to API keys.
idstringrequiredChange a member's role
Sets another member's role. Admin only. A caller can never change their own role: every change is made by an admin who stays an admin, so an organization cannot lose its last admin. Applies on the member's next request.
idstringrequireduserIdstringrequiredrolestringrequireduserstring · uuidrequiredemailstring · emailrequirednamestringnullablerolestringrequiredjoinedAtstring · date-timerequiredRemove a member, or leave
Removes a member from the organization. When userId is the caller (or me) this is a leave, allowed to any member; otherwise the caller must be an admin. The last admin cannot leave: make another member an admin first, or delete the organization. The removed member's API keys for this organization stop working.
idstringrequireduserIdstringrequired