Get Consumer Organization

Endpoint

GET /apiops/projects/{projectName}/consumer-organizations/{code}

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
code	string	Yes	Code of the organization

Response

200 OK with the organization. An unknown code answers 404 resourceNotFound.

Field	Type	Description
code	string	Code of the organization. Unique in the project. Immutable
nameDefault	string	Default display name
nameSecondary	string	Secondary display name
parentOrganizationCode	string	Code of the parent organization. Absent for a top-level organization
metadata	array	Custom metadata entries. The value of a secret entry is omitted

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/consumer-organizations/acme-partners" \
  -H "Authorization: Bearer YOUR_TOKEN"

Permissions

• User must have IDENTITY + VIEW permission in the project
• A project outside the scope of the caller answers 404 resourceNotFound, never 403
• The admin project has no consumer organizations: a call on it answers 400 malformedRequest (params.reason = platformScopeNotSupported)