Organizations

1 minute read

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

Retrieve an organization’s UUID (organizationId) using its domain name.

Endpoint
GET /v1/organizations/name
Parameter name In Type Required? Description

name

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.

api.organization.GetOrganizationByNameResponse

Default

Error. Occurs when the domain name is missing, invalid, or the user lacks permission.

google.rpc.Status

Response example
{ "organization": { "id": "<organization_id>", "<1>" "displayName": "your organization", "domainName": "<domain_name>" } }
1 The organizationId is the UUID of the organization you queried using its domain name.