List Consumer Organizations
Endpoint
GET /apiops/projects/{projectName}/consumer-organizations
Authentication
Requires a Personal API Access Token.
Authorization: Bearer YOUR_TOKEN
Request
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| search | string | No | Case-insensitive contains-match on code and default name |
| page | integer | No | Zero-based page index. Default 0 |
| size | integer | No | Rows per page. Default 20, capped at 200 |
| sort | string | No | field,asc or field,desc. Fields: code, nameDefault. Default code,asc |
Response
200 OK with the paged envelope. Each item is an organization:
| 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?search=acme" \
-H "Authorization: Bearer YOUR_TOKEN"
Permissions
- User must have
IDENTITY+VIEWpermission in the project - A project outside the scope of the caller answers
404 resourceNotFound, never403 - The admin project has no consumer organizations: a call on it answers
400 malformedRequest(params.reason=platformScopeNotSupported)