API Publication
List Publications
Returns a collection of all API Publications.
get/v3/api-publications
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filters API Publications in the response.
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
Sorts a collection of API publications. Supported sort attributes are:
- portal_id
- portal_name
- api_id
- api_name
- created_at
- updated_at
Response
Paginated list of API publications
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"api_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
"portal_id": "7710d5c4-d902-410b-992f-18b814155b53",
"entity_type": "api",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}