v1

latestOpenAPI 3.0.32026-07-22115106141.4 KB

Organization Management

List user's organizations

Lists all organizations the user is a member of, optionally filtered to show only owned organizations when owned=true.

Sorting: Results are sorted alphabetically by organization name.

Information included: Each organization includes:

Basic metadata
A flag indicating if it's in a warning group (quota breach or payment issue)

Returns: An empty list if the user is not a member of any organizations.

get/organizations

Query parameters

ownedboolean

Filter by organizations owned by the user or not.

Response

Success

object'Organization' required

Example response

{
  "items": [
    {
      "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
    }
  ]
}