Organizations

Create a new organization

Creates a new organization with the authenticated user as owner.

post/v2/organization

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/organization
  • Auth: HTTP bearer

Request body

namestring

URL-safe unique organization name (optional, generated from displayName)

displayNamestring required

Human-readable organization display name

emailstring email

Organization email address (optional)

acceptedBystring uuid required

UUID of the user who accepted the terms of service

Example request

{
  "name": "zephyr-cloud",
  "displayName": "Zephyr Cloud",
  "email": "contact@zephyr-cloud.io",
  "acceptedBy": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Organization created successfully

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "zephyr-cloud",
    "displayName": "Zephyr Cloud",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-06-15T12:30:00.000Z",
    "domains": [
      "@zephyr-cloud.io",
      "@zephyrcloud.com"
    ],
    "defaultRole": "viewer",
    "subscriptionTier": "PERSONAL",
    "subscriptionOwner": true,
    "subscriptionId": "sub_1234567890"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.