GET /apis

This call fetches all the APIs present in the specified workspace

Response contains an array named apis which would contain all the details of APIs present in the workspace.

Requires API Key as X-Api-Key request header or apikey URL query parameter.

Servers

Query parameters

Name Type Required Description
isPublic String No

Only return APIs with the corresponding privacy state. Public APIs have the isPublic value true; private APIs have the isPublic value false.

name String No

Only return APIs whose name includes the given value. Matching is case insensitive.

description String No

Only return APIs whose description includes the given value. Matching is case insensitive.

direction String No

The sorting direction, which can be ascending or descending. The value can be asc to specify an ascending direction or desc to specify a descending direction. If none is specified, the default sorting direction is descending for timestamp and numeric fields and ascending otherwise. An ID is not considered a numeric field.

updatedBy String No

Only return APIs that have been updated by the user ID represented by the given value.

sort String No

The value of sort can be one of the names of the fields included in the response.

until String No

Only return APIs that have been updated before this time. Time is represented using the ISO 8601 date and time format.

since String No

Only return APIs that have been updated after this time. Time is represented using the ISO 8601 date and time format.

workspace String No

Only return APIs that are inside the given workspace.

summary String No

Only return APIs whose summary includes the given value. Matching is case insensitive.

createdBy String No

Only return APIs that have been created by the user ID represented by the given value.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.