15_Days_of_Postman_-_for_testers_IvanKo API Documentation
Get an API
GET {{baseUrl}}/apis/{{apiId}}
Gets information about an API. Note:
versions and gitInfo query responses. This is because schema and collection information is stored in the connected Git repository. The gitInfo object only lists the repository and folder locations of the files.versions option in the include query parameter.
Body
PARAM
| Key | Datatype | Required | Description |
include
|
string | An array that contains one or more of the following additional resources to include in the response. Use this parameter to query for element links to the API, such as collections and schemas: - `collections` — Query for linked Postman collections. - `versions` — Query for linked versions. - `schemas` — Query for linked schemas. - `gitInfo` — Query for information about the API’s git-linked repository. This query only returns the linked repository and folder locations of the files. It does **not** return `collections` or `schemas` information. **Note:** API viewers can only use the `versions` option. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"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",
"versions": [
{
"id": "18ccb2dc-1746-4945-ba76-8152b37cr123",
"name": "v1.0.0"
},
{
"id": "5260b75f-447e-467c-9299-12f16c924503",
"name": "v1.0.1"
}
]
} |
Curl
curl -X GET 'https://api.getpostman.com/apis/apiId?include=<string>' -H 'Accept: application/vnd.api.v10+json'
ENDPOINTS