List organizations

GET /organizations

Fetch organizations available to the current user. Currently unavailable in self-hosted ECE.

Responses

200

Organizations fetched successfully
Hide response attributes Show response attributes object
- organizations array[object] Required
  
  The list of organizations
  
  Hide organizations attributes Show organizations attributes object
  
  id string Required
  
  The organization's identifier
  
  name string Required
  
  The organization's friendly name
  
  default_disk_usage_alerts_enabled boolean
  
  Whether the default disk alerts are enabled
  
  notifications_allowed_email_domains array[string]
  
  The list of allowed domains for notification-email recipients
  
  billing_contacts array[string]
  
  The list of contacts for billing notifications, if specified
  
  operational_contacts array[string]
  
  The list of contacts for operational notifications, if specified
- next_page string
  
  A cursor to get the next page of results
401

User not found. (code: user.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is user.not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

GET /organizations

curl \
 -X GET https://{{hostname}}/api/v1/organizations

Response examples (200)

{
  "organizations": [
    {
      "id": "string",
      "name": "string",
      "default_disk_usage_alerts_enabled": true,
      "notifications_allowed_email_domains": [
        "string"
      ],
      "billing_contacts": [
        "string"
      ],
      "operational_contacts": [
        "string"
      ]
    }
  ],
  "next_page": "string"
}

Response examples (401)

# Headers
x-cloud-error-codes: user.not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}