Fetch organization information

GET /organizations/{organization_id}

Fetch a single organization by id. Currently unavailable in self-hosted ECE.

Path parameters

organization_id string Required

Identifier for the Organization

Responses

200

Organization fetched successfully
Hide response attributes Show response 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
- sso_login_identifier string
  
  The login identifier for initiating SSO
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
403

The current user does not have access to the requested organization. (code: organization.invalid_access)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is organization.invalid_access.
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
404

Organization not found. (code: organization.not_found)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is organization.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/{organization_id}

curl \
 -X GET https://api.elastic-cloud.com/api/v1/organizations/{organization_id}

Response examples (200)

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

Response examples (401)

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

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

Response examples (403)

# Headers
x-cloud-error-codes: organization.invalid_access

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

Response examples (404)

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

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