Manage Organizations

Organizations represent corporate structures within the API Control Plane. They group APIs, applications, and users, serving as the ownership and access-control boundary for your API landscape.

Apart from global administrators, users can only access elements owned by their own organization. However, APIs and API Products can be shared across organizational boundaries through visibility settings — you can configure whether a product is visible to all users or only to members of specific organizations.

Organizations support a hierarchical structure with parent-child relationships and can be typed as CONSUMER, PUBLISHER, or BOTH, reflecting their role in the API ecosystem.

List organizations

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Filter parameters

Parameter	Type	Description
text	string	Free-text search
name	string	Filter by name

Create an organization

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "engineering",
    "displayName": "Engineering Team"
  }'

Get an organization

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>" \
  -H "Authorization: Bearer <your-token>"

Update an organization

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "engineering",
    "displayName": "Engineering Department"
  }'

Delete an organization

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>" \
  -H "Authorization: Bearer <your-token>"

Manage organization members

List members

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/users" \
  -H "Authorization: Bearer <your-token>"

Add a user to an organization

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/users/<user-id>" \
  -H "Authorization: Bearer <your-token>"

Remove a user from an organization

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/users/<user-id>" \
  -H "Authorization: Bearer <your-token>"

Organization scores

Get governance scores for an organization:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/scores" \
  -H "Authorization: Bearer <your-token>"

Organization image

# Upload
curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/image" \
  -H "Authorization: Bearer <your-token>" \
  -F "file=@org-logo.png"

# Download
curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/image" \
  -H "Authorization: Bearer <your-token>" --output org-logo.png

# Delete
curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/organizations/<org-id>/image" \
  -H "Authorization: Bearer <your-token>"