Organizations

Get organization details

Retrieves organization details by name. Includes the current user's role in the organization.

get/v2/organization/{organization}

Request

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

Path parameters

organizationstring required

Organization unique name (URL-safe slug)

Example:zephyr-cloud

Response

Organization details with user role

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",
    "email": "contact@zephyr-cloud.io",
    "description": "A modern cloud deployment platform",
    "socialAccounts": [
      {
        "link": "https://github.com/zephyr-cloud",
        "label": "GitHub"
      }
    ],
    "location": "San Francisco, CA",
    "avatarColor": "#3B82F6",
    "role": "viewer"
  }
}

Changes

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