Sign in

v1

latestOpenAPI 3.0.32026-07-22115106141.4 KB
Organization Management

Create organization

Creates a new organization with the user as the owner If the user is already a member of an organization with the same name, the request will fail

post/organizations

Request body

namestring required

Example request

{
  "name": "Example Organization"
}

Response

Organization created

idstring required

Unique identifier for the organization

namestring required

Name of the organization

descriptionstring

Description of the organization

owner_idstring required

ID of the user who owns the organization

total_storageinteger required

Total storage allocated to the organization

in_warning_groupboolean

Whether the organization is in the warning group

Example response

{
  "id": "org_123456",
  "name": "Example Organization",
  "description": "This is an example organization.",
  "owner_id": "user_123456",
  "total_storage": 1000000,
  "members": [
    {
      "id": "member_123456",
      "user_id": "user_123456",
      "organization_id": "org_123456"
    }
  ],
  "invites": [
    {
      "id": 123456,
      "organization_id": "org_123456",
      "organization_name": "Great Organization",
      "inviting_user_id": "user_123456",
      "inviting_user_name": "John Doe",
      "invited_email": "john.doe@example.com",
      "created": "2023-01-01T00:00:00Z",
      "expires": "2023-01-31T00:00:00Z"
    }
  ],
  "in_warning_group": true
}