Get the Organization
Returns the Organization of the API key.
GET /organizations/{organizationId}
Permission: Organization (Read). See API permissions.
Request
Section titled “Request”| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
organizationId | Path | string | Yes | The Organization ID of the API key. Any other ID returns 404. |
Request example
curl "$API_BASE_URL/organizations/$ORGANIZATION_ID" \ -H "Authorization: Bearer $NCP_API_TOKEN"Response
Section titled “Response”| Field | Type | Description |
|---|---|---|
organizationId | string | The Organization ID. |
name | string | The name of the Organization. |
Response example
{ "organizationId": "642012", "name": "Example Org"}Errors
Section titled “Errors”| Status | errorCode | When |
|---|---|---|
404 | RESOURCE_NOT_FOUND | organizationId is not the Organization of the API key. |
Errors common to all operations are in Errors.