List APIs

Returns a paginated list of published APIs.

get
/api/v3/apis

Query Parameters

filterobject

Filters APIs in the response.

Show Child Parameters
sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

Response for a list of apis.

ApiListPage

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

API Attributes

Endpoints for viewing attributes across APIs published to the portal.

List API Attributes

Get a paginated list of all attributes across APIs in the portal.
If authenticated, results will include attributes of APIs visible to the authenticated user.
If not authenticated, results will include only attributes of publicly visible APIs.

When the selected query parameter is provided, the response will include a selected_api_count
field for each attribute value, indicating how many APIs would match that attribute value
when combined with the currently selected filters.

get
/api/v3/api-attributes

Query Parameters

filterobject

Filters API attributes in the response.

Show Child Parameters
selectedobject

Specifies selected attribute values to calculate filtered API counts.
Use the format: selected[<attribute_key>]=<attribute_value_1>,<attribute_value_2>
When provided, the response will include selected_api_count for each attribute value.

Example:{"domain":"airlines,flights","visibility":"external"}

Response

application/json

Paginated list of attributes across all APIs published in this portal.

ListApiAttributesPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
application/json

Get API Image

Returns the specified image from the API.

get
/api/v3/apis/{apiIdOrSlug}/images/{imageType}/raw

Path Parameters

apiIdOrSlugOne Of
required

The API identifier, either ApiId or Api Slug

ApiIdstring(uuid)read-only

The API identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

imageTypestringrequired

The Supported image type.

Allowed values:icon

Example:icon

Response

Redirect to the image URL.

ApiSlug

string

The Api slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

Match pattern:^[\w-]+$

Example