Developer APIResourcesAPI platform

List endpoints in a collection

Lists all API endpoints. Specify the api_collection_id to obtain the list of endpoints in a specific collection.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number of the API endpoints to fetch. Defaults to 1.

per_pageintegerOptional

Number of API endpoints to return in a single page. Defaults to 100. Max is 100.

api_collection_idintegerOptional
ID of the API collection. If the parameter is not provided, all API endpoints are returned.

Response

Success reply
idinteger or null
The ID of the API endpoint.
api_collection_idinteger or null
The ID of the API collection.
flow_idinteger or null
The ID of the API recipe associated with this endpoint.
namestring or null
The name of the endpoint.
methodstring or null

The HTTP method used to access the endpoint. For example, GET, POST, PUT, and more.

urlstring or null
The URL for accessing the endpoint.
legacy_urlstring or null

Legacy URL (if applicable).

base_pathstring or null
The base path for the endpoint.
pathstring or null
The specific path for the endpoint.
activeboolean or null
Indicates if the endpoint is active.
legacyboolean or null
Indicates if the endpoint is a legacy endpoint.
created_atstring or null
Timestamp in ISO 8601 format.
updated_atstring or null
Timestamp in ISO 8601 format.

Errors