Filters endpoints by the specified apiCategoryName, including the __UNCATEGORIZED__ keyword.

The search query substring criteria matching the endpoint's name, description, basePath, apiCategoryName, and resourcePath.

Enum The field to sort endpoints by, either the updateDate or the API name that corresponds to the apiEndPointName in data. The default is name.

Enum The sort order, either desc for descending or the default asc for ascending.

Enum The preference for selecting the endpoint version to return. By default the API returns the LAST_UPDATED version. If you set the preference to ACTIVATED_FIRST, the API first attempts to return the version currently active on the production network. If such version doesn't exist, the API attempts to return the version currently active on the staging network. If both of these checks fail, the API returns the last updated version.

Enum The type of endpoints to return based on their visibility status. By default the API returns ALL endpoints. You can instead decide to return ONLY_VISIBLE endpoints, or ONLY_HIDDEN endpoints. Run the Show an endpoint and Hide an endpoint operations to control which endpoints are listed.

Filters endpoints to a specific contract. You need to specify this along with a groupId.

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Generated from available response content types