This page provides an API reference for retrieving an organization’s UUID (organizationId) using its domain name. It includes endpoint details, required parameters, example requests, and responses. Use this API when you need to identify your organization for use in other CloudBees platform API calls.
Retrieve an organization ID
To manage or perform organization-scoped API calls, you need the UUID (organizationId) for your target organization. You can obtain this UUID in one of two ways:
-
Through the CloudBees Platform UI. Refer to Organizations and sub-organizations.
-
Programmatically using the following endpoint, which retrieves an organization’s UUID based on its domain name.
Retrieve an organization’s UUID (organizationId) using its domain name.
GET /v1/organizations/name
| Parameter name | In | Type | Required? | Description |
|---|---|---|---|---|
|
Query |
String |
Yes |
The domain name of the organization. |
Responses
The following table outlines the possible responses for this endpoint, including status codes, their meanings, and the schemas that describe the structure of the returned data or errors.
| Status Code | Description | Schema |
|---|---|---|
200 |
Success. The request returned organization metadata for the given domain name. |
|
Default |
Error. Occurs when the domain name is missing, invalid, or the user lacks permission. |
|
{ "organization": { "id": "<organization_id>", "<1>" "displayName": "your organization", "domainName": "<domain_name>" } }
| 1 | The organizationId is the UUID returned for the organization you queried by domain name. |