Method: organizations.apiproducts.get

Gets an API product from an organization. The API product name required in the request URL is not the "Display Name" value displayed for the API product in the Edge UI. While they may be the same, they are not always the same depending on whether the API product was created via UI or API. For this reason, be sure to get the exact API product name by performing a GET request to the List API Products endpoint. Use the "name" value returned in the response as the API product name in the request URL.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. API product name of the form: organizations/{organizationId}/apiproducts/{api_product_name}

Query parameters



Set query type to count to obtain an entity count, and list to obtain a list of entities.



Specify the type of entity for which you want to get a count: keys, apps, developers, or companies.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ApiProduct.

Authorization Scopes

Requires the following OAuth scope: