Skip to main content
Returns API endpoints visible on the current site in a paginated manner. Suitable for finding APIs by business path, service, or release stage; if you only need the complete definition of one API, please directly call API Details.

API Overview

Query Parameters

id, service_id, and tag are currently not list filter parameters; passing them will not produce corresponding filtering effects.

Response Description

The online response uses {count, items}. Each list item currently includes API model fields, as well as:
  • document_id: Associated developer document ID, may be empty;
  • service_id / service: Primary service ID and summary, may be empty;
  • definition: OpenAPI definition, which may be large;
  • method, path, path2, stage, cost, tags, metadata, etc.
The list serializer currently includes definition; when retrieving the full catalog, pagination and timeouts should be set. Fields may be added in a backward-compatible manner, and clients should only read the required fields.

Next Steps