GET https://api.getpostman.com/apis
Gets information about all APIs.
Body
PARAM
Key | Datatype | Required | Description |
workspace
|
string | Optional. Return only APIs that are inside the given workspace. | |
since
|
string | Optional. Return only APIs updated at and after this time, in ISO 8601 UTC format. | |
until
|
string | Optional. Return only APIs updated at and before this time, in ISO 8601 UTC format. | |
createdBy
|
string | Optional. Return only APIs created by the given user ID. | |
updatedBy
|
string | Optional. Return only APIs updated by the given user ID. | |
isPublic
|
string | Optional. If true, return only public APIs; if false, return only private APIs. | |
name
|
string | Optional. Return only APIs whose name includes the given value. Matching is not case-sensitive. | |
summary
|
string | Optional. Return only APIs whose summary includes the given value. Matching is not case-sensitive. | |
description
|
string | Optional. Return only APIs whose description includes the given value. Matching is not case-sensitive. | |
sort
|
string | Optional. Sort the results by the given value. If you use this query parameter, you must also use the `direction` parameter. | |
direction
|
string | Optional. Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this query parameter, you must also use the "sort" parameter. |
HEADERS
Key | Datatype | Required | Description |
RESPONSES
status OK
{
"apis": [
{
"createdAt": "2022-06-09T14:48:45.000Z",
"updatedAt": "2022-06-09T19:50:49.000Z",
"id": "5360b75f-447e-467c-9299-12fd6c92450d",
"name": "Test API",
"summary": "Test API.",
"description": "This is a test API.",
"createdBy": "12345678",
"updatedBy": "12345678",
"isPublic": true
},
{
"createdAt": "2022-06-22T16:51:28.000Z",
"updatedAt": "2022-06-22T16:51:28.000Z",
"id": "69ce25ea-2914-426e-ae34-af558b6777e6",
"name": "Public API A",
"summary": "Public Test A.",
"description": "This is a public test API.",
"createdBy": "12345678",
"updatedBy": "12345678",
"isPublic": true
},
{
"createdAt": "2022-06-30T16:51:28.000Z",
"updatedAt": "2022-06-30T16:51:28.000Z",
"id": "69ce25ea-2914-426e-ae34-af558b6777e6",
"name": "Public Test API B",
"summary": "Public Test B",
"description": "This is another public test API.",
"createdBy": "87654321",
"updatedBy": "87654321",
"isPublic": false
}
]
} |
ENDPOINTS