# IBM API Connect Consumer Management API

**Canonical:** https://apis.io/apis/ibm-api-connect/ibm-api-connect-consumer-management-api/  
**Provider:** IBM API Connect — https://apis.io/providers/ibm-api-connect/  
**Base URL:** https://{platform-api-endpoint}/api  
**Documentation:** https://apic-api.apiconnect.ibmcloud.com/v12/

IBM API Connect Consumer Management API is one of 43 APIs that [IBM API Connect](https://apis.io/providers/ibm-api-connect/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Consumer Management. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

The Consumer Management API from IBM API Connect — 65 operation(s) for consumer management.

## Operations (60 of 150)

| Method | Path | Summary |
|---|---|---|
| GET | `/groups/{group}` | Get the Group object by name or id |
| POST | `/catalogs/{org}/{catalog}/apps` | Create a Application object |
| GET | `/catalogs/{org}/{catalog}/apps` | Lists consumer apps |
| DELETE | `/catalogs/{org}/{catalog}/apps` | Clear the Application objects |
| GET | `/catalogs/{org}/{catalog}/apps/{app}` | Get the Application object by name or id |
| PATCH | `/catalogs/{org}/{catalog}/apps/{app}` | Update the Application object by name or id |
| DELETE | `/catalogs/{org}/{catalog}/apps/{app}` | Delete the Application object by name or id |
| POST | `/spaces/{org}/{catalog}/{space}/apps` | Create a Application object |
| GET | `/spaces/{org}/{catalog}/{space}/apps` | Lists consumer apps |
| DELETE | `/spaces/{org}/{catalog}/{space}/apps` | Clear the Application objects |
| GET | `/spaces/{org}/{catalog}/{space}/apps/{app}` | Get the Application object by name or id |
| PATCH | `/spaces/{org}/{catalog}/{space}/apps/{app}` | Update the Application object by name or id |
| DELETE | `/spaces/{org}/{catalog}/{space}/apps/{app}` | Delete the Application object by name or id |
| GET | `/consumer-orgs/{org}/{catalog}/{consumer-org}/settings` | Returns consumer organization settings |
| PUT | `/consumer-orgs/{org}/{catalog}/{consumer-org}/settings` | Updates consumer organization settings |
| DELETE | `/consumer-orgs/{org}/{catalog}/{consumer-org}/settings` | Deletes consumer organization settings |
| GET | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings` | Returns consumer organization settings |
| PUT | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings` | Updates consumer organization settings |
| DELETE | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings` | Deletes consumer organization settings |
| POST | `/catalogs/{org}/{catalog}/consumer-org-invitations` | Create a Consumer Organization Invitation object |
| GET | `/catalogs/{org}/{catalog}/consumer-org-invitations` | Lists consumer organization invitations |
| DELETE | `/catalogs/{org}/{catalog}/consumer-org-invitations` | Clears consumer organization invitations |
| GET | `/catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}` | Returns a consumer organization invitation |
| PATCH | `/catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}` | Updates a consumer organization invitation |
| DELETE | `/catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}` | Deletes a consumer organization invitation |
| POST | `/catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate` | Regenerate the Consumer Organization Invitation |
| POST | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations` | Creates a consumer organization invitation |
| GET | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations` | Lists consumer organization invitations |
| DELETE | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations` | Clears consumer organization invitations |
| GET | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}` | Returns a consumer organization invitation |
| PATCH | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}` | Updates a consumer organization invitation |
| DELETE | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}` | Deletes a consumer organization invitation |
| POST | `/spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate` | Regenerate the Consumer Organization Invitation |
| POST | `/catalogs/{org}/{catalog}/consumer-orgs` | Creates a consumer organization |
| GET | `/catalogs/{org}/{catalog}/consumer-orgs` | Lists consumer organizations |
| DELETE | `/catalogs/{org}/{catalog}/consumer-orgs` | Clears consumer organizations |
| GET | `/consumer-orgs/{org}/{catalog}/{consumer-org}` | Returns a consumer organization |
| PATCH | `/consumer-orgs/{org}/{catalog}/{consumer-org}` | Updates a consumer organization |
| DELETE | `/consumer-orgs/{org}/{catalog}/{consumer-org}` | Deletes a consumer organization |
| POST | `/consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner` | Transfer owner to an associate |
| POST | `/spaces/{org}/{catalog}/{space}/consumer-orgs` | Creates a consumer organization |
| GET | `/spaces/{org}/{catalog}/{space}/consumer-orgs` | Lists consumer organizations |
| DELETE | `/spaces/{org}/{catalog}/{space}/consumer-orgs` | Clears consumer organizations |
| GET | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}` | Returns a consumer organization |
| PATCH | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}` | Updates a consumer organization |
| DELETE | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}` | Deletes a consumer organization |
| POST | `/consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner` | Transfer owner to an associate |
| POST | `/catalogs/{org}/{catalog}/consumer-groups` | Creates a consumer group |
| GET | `/catalogs/{org}/{catalog}/consumer-groups` | Lists consumer groups |
| DELETE | `/catalogs/{org}/{catalog}/consumer-groups` | Clears consumer groups |
| GET | `/catalogs/{org}/{catalog}/consumer-groups/{group}` | Returns a consumer group |
| PATCH | `/catalogs/{org}/{catalog}/consumer-groups/{group}` | Updates a consumer group |
| DELETE | `/catalogs/{org}/{catalog}/consumer-groups/{group}` | Deletes a consumer group |
| POST | `/spaces/{org}/{catalog}/{space}/consumer-groups` | Create a Group object |
| GET | `/spaces/{org}/{catalog}/{space}/consumer-groups` | List the Group objects |
| DELETE | `/spaces/{org}/{catalog}/{space}/consumer-groups` | Clear the Group objects |
| GET | `/spaces/{org}/{catalog}/{space}/consumer-groups/{group}` | Get the Group object by name or id |
| PATCH | `/spaces/{org}/{catalog}/{space}/consumer-groups/{group}` | Update the Group object by name or id |
| DELETE | `/spaces/{org}/{catalog}/{space}/consumer-groups/{group}` | Delete the Group object by name or id |
| POST | `/consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods` | Create a Payment Method object |

…and 90 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-consumer-management-api-openapi.yml
- **Reference** — https://apic-api.apiconnect.ibmcloud.com/v12/
- **Documentation** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
- **GettingStarted** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
- **Authentication** — https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys

## Other IBM API Connect APIs (12)

- [IBM API Connect Platform - Cloud Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-cloud-management-api/)
- [IBM API Connect Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-analytics-api/)
- [IBM API Connect Consumer Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-consumer-analytics-api/)
- [IBM API Connect Engagement API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-engagement-api/)
- [IBM API Connect Discovery API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-discovery-api/)
- [IBM API Connect AI Assets API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-ai-assets-api/)
- [IBM API Connect Application Strategy management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-application-strategy-management-api/)
- [IBM API Connect Billing Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-billing-management-api/)
- [IBM API Connect Catalog Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-management-api/)
- [IBM API Connect Catalog Resource API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resource-api/)
- [IBM API Connect Catalog Resources API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resources-api/)
- [IBM API Connect Catalog Settings API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-settings-api/)

## Tags

Consumer Management

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ibm-api-connect/ibm-api-connect-consumer-management-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ibm-api-connect/.