Fetch organization information

edit

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

Request

edit

GET /api/v1/organizations/{organization_id}

Path parameters

edit
Name Type Required Description

organization_id

string

Y

Identifier for the Organization

Responses

edit
200

(Organization)

Organization fetched successfully

401

(BasicFailedReply)

User not found. (code: user.not_found)

Headers

x-cloud-error-codes (string; allowed values: [user.not_found])
The error codes associated with the response
403

(BasicFailedReply)

The current user does not have access to the requested organization. (code: organization.invalid_access)

Headers

x-cloud-error-codes (string; allowed values: [organization.invalid_access])
The error codes associated with the response
404

(BasicFailedReply)

Organization not found. (code: organization.not_found)

Headers

x-cloud-error-codes (string; allowed values: [organization.not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/organizations/{organization_id} \
-H "Authorization: ApiKey $ECE_API_KEY"