30-day challenge API Documentation
Get an API
GET https://api.getpostman.com/apis/{{apiId}}
Gets information about an API.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"api": {
"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",
"team": "1234",
"isPublic": true,
"versions": [
{
"id": "a9879d02-74bf-425a-bbec-6d27aa135507",
"name": "Draft",
"summary": null,
"schemas": [
{
"id": "16bb367e-fafb-4ef3-933b-ee3d971866fb",
"type": "openapi3",
"language": "json",
"content": "{\n \"openapi\": \"3.0.0\",\n \"info\": {\n \"version\": \"1.0.0\",\n \"title\": \"Test API\"\n },\n \"servers\": [\n {\n \"url\": \"http://locahost:3000\"\n }\n ],\n \"paths\": {\n \"/user\": {\n \"get\": {\n \"summary\": \"List all users\",\n \"operationId\": \"listUser\",\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"query\",\n \"required\": true,\n \"description\": \"The user's ID.\",\n \"example\": 1234,\n \"schema\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n }\n }\n ],\n \"responses\": {\n \"200\": {\n \"description\": \"Information about the user.\",\n \"headers\": {\n \"x-next\": {\n \"description\": \"A link to the next page of responses.\",\n \"schema\": {\n \"type\": \"string\"\n }\n }\n },\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"$ref\": \"#/components/schemas/User\"\n }\n }\n }\n }\n }\n }\n }\n },\n \"components\": {\n \"schemas\": {\n \"User\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"name\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"tag\": {\n \"type\": \"string\"\n }\n }\n },\n \"Error\": {\n \"type\": \"object\",\n \"required\": [\n \"code\",\n \"message\"\n ],\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int32\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}"
}
],
"relations": [
{
"id": "66b88a55-9e52-41b0-8577-7b6798ff5bee",
"model": "apiDefinition",
"type": "apiDefinition",
"modelId": "66b88a55-9e52-41b0-8577-7b6798ff5bee"
},
{
"id": "66b88a55-9e52-41b0-8577-7b6798ff5bee",
"model": "schema",
"type": "schema",
"modelId": "66b88a55-9e52-41b0-8577-7b6798ff5bee"
}
]
}
]
}
} |
Curl
curl -X GET 'https://api.getpostman.com/apis/undefined'
ENDPOINTS