# API Experience Hub Consumer API

Discover APIs and request access from a published API Experience Hub portal.

Use this API to act on behalf of an authenticated portal consumer (developer) browsing a
Salesforce-hosted developer porta...

- **Version:** 1.0.0
- **Category:** Platform
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/api-experience-hub-consumer/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/api-experience-hub` — US
- `https://eu1.anypoint.mulesoft.com/api-experience-hub` — EU
- `https://ca1.platform.mulesoft.com/api-experience-hub` — CA
- `https://jp1.platform.mulesoft.com/api-experience-hub` — JP

## Operations (20)
### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}

**Operation ID:** `getApplicationDetailById`
Get application details
Returns detailed information about a specific application including credentials.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). | required |
| `applicationId` | query | Unique identifier of the application | required |

### PUT /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}

**Operation ID:** `updateApplication`
Update an application
Updates the details of an existing client application.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |

### DELETE /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}

**Operation ID:** `deleteApplication`
Delete an application
Permanently deletes a client application.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |

### POST /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/search

**Operation ID:** `searchCommunityAssets`
Search portal assets
Searches for API assets published in a portal by keyword, categories, tags or asset types.

**Parameters:**
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `x-limit` | query | Maximum number of search results to return | optional |

### POST /xapi/v1/portals/{targetOrganizationId}/{portalId}/assets/{groupId}/{assetId}/{minorVersion}/applications

**Operation ID:** `createApplication`
Create an application
Creates a new client application for requesting API access.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |

### POST /xapi/v1/portals/{targetOrganizationId}/{portalId}/assets/{groupId}/{assetId}/{minorVersion}/contracts

**Operation ID:** `createContract`
Create a contract
Creates an API access contract between an application and an API instance.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |

### POST /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}/secret/reset

**Operation ID:** `resetClientSecretForApplication`
Reset client secret
Generates a new client secret for the specified application.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |

### PATCH /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}/contracts/{contractId}/tiers/{tierId}

**Operation ID:** `assignSlaTierToContract`
Update contract SLA tier
Changes the SLA tier assigned to an existing contract.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |
| `contractId` | query | Unique identifier of the contract | required |
| `tierId` | query | ID of the SLA tier to assign | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets

**Operation ID:** `listAssetsCommunityAsset`
List portal assets
Returns a paginated list of assets published in the portal, sorted by recently added.

**Parameters:**
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `limit` | query | Maximum number of assets to return (max 250) | optional |
| `offset` | query | Number of results to skip for pagination | optional |

### GET /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/terms

**Operation ID:** `getTermsAndConditions`
Get terms and conditions
Returns the terms and conditions in markdown format for a specific asset.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/resources/{resourceId}

**Operation ID:** `getAssetResource`
Get asset resource
Returns a binary resource file associated with an asset's documentation.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `resourceId` | query | Unique identifier of the asset resource file | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/pages/**

**Operation ID:** `getAssetPages`
Get documentation page
Returns a documentation page in markdown format for a specific asset.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{targetPortalId}/assets/{groupId}/{assetId}/{minorVersion}/details

**Operation ID:** `getAssetDetails`
Get asset details
Returns detailed information about a specific API asset including instances, categories and documentation pages.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `targetPortalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/assets/{groupId}/{assetId}/{minorVersion}/instances/{instanceId}/tiers

**Operation ID:** `getTiers`
List SLA tiers
Returns the available SLA tiers for an API instance.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `instanceId` | query | Unique identifier of the API instance | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/assets/{groupId}/{assetId}/{minorVersion}/instances/{instanceId}/provider/grantTypes

**Operation ID:** `getGrantTypesByInstanceId`
Get grant types by instance
Returns the available OAuth grant types for an API instance's provider.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `instanceId` | query | Unique identifier of the API instance | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/assets/{groupId}/{assetId}/{minorVersion}/contracts/{applicationId}/{instanceId}

**Operation ID:** `getContract`
Get contract details
Returns a specific contract for an application and instance.

**Parameters:**
| `minorVersion` | query | Minor version of the asset (e.g. 1.0) | required |
| `assetId` | query | Exchange asset ID | required |
| `groupId` | query | Exchange group ID of the asset | required |
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |
| `instanceId` | query | Unique identifier of the API instance | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications

**Operation ID:** `getApplications`
List applications
Returns applications with optional filtering by instance and name.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `instanceId` | query | Filter applications by API instance ID | optional |
| `query` | query | Filter applications by name | optional |
| `limit` | query | Maximum number of results to return | optional |
| `offset` | query | Number of results to skip for pagination | optional |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}/provider/grantTypes

**Operation ID:** `getGrantTypesByApplicationId`
Get grant types by application
Returns the available OAuth grant types for an application's provider.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/{applicationId}/contracts

**Operation ID:** `getContractsByApplicationId`
List contracts for application
Returns all contracts associated with a specific application.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `applicationId` | query | Unique identifier of the application | required |
| `limit` | query | Maximum number of results to return | optional |
| `offset` | query | Number of results to skip for pagination | optional |

### GET /xapi/v1/portals/{targetOrganizationId}/{portalId}/applications/exists

**Operation ID:** `checkExistenceApplicationName`
Check application name availability
Checks whether a given application name is already in use.

**Parameters:**
| `portalId` | query | Unique identifier of the portal | required |
| `targetOrganizationId` | query | External organization ID tied to the connection (e.g. Salesforce organization ID for SALESFORCE connections). Obtained from the connection record, not from Anypoint access-management. | required |
| `appName` | query | Application name to check for availability | required |


## Related Skills
- [discover-portal-apis](https://dev-portal.mulesoft.com/skills/discover-portal-apis.md) — Discover APIs published in an API Experience Hub portal as a portal
consumer. Use when an end user needs to browse the catalog, search
assets by keyword or filter, open an API's detail page, read its terms
and conditions, or fetch rendered documentation pages and resources.
- [manage-portal-applications](https://dev-portal.mulesoft.com/skills/manage-portal-applications.md) — Manage the applications that hold API credentials inside an API Experience
Hub portal. Use when a portal consumer needs to list their applications,
check if a name is available, create a new application, update metadata,
rotate the client secret, or delete an application they no longer use.
- [request-api-access](https://dev-portal.mulesoft.com/skills/request-api-access.md) — Request access to a published API in an API Experience Hub portal by
creating a contract between one of your applications and a specific API
instance/tier. Use when a portal consumer needs to discover available
tiers and grant types, create a contract, review existing contracts,
or change an SLA tier on an active contract.