Postman API
  1. API
Postman API
  • API
    • Get all APIs
      GET
    • Create API
      POST
    • Delete an API
      DELETE
    • Single API
      GET
    • Update an API
      PUT
    • Get All API Versions
      GET
    • Create API Version
      POST
    • Delete an API Version
      DELETE
    • Get an API Version
      GET
    • Update an API Version
      PUT
    • Get contract test relations
      GET
    • Get documentation relations
      GET
    • Get environment relations
      GET
    • Get integration test relations
      GET
    • Get monitor relations
      GET
    • Get linked relations
      GET
    • Create relations
      POST
    • Create Schema
      POST
    • Get Schema
      GET
    • Update Schema
      PUT
    • Create collection from schema
      POST
    • Get test suite relations
      GET
    • Sync relations with schema
      PUT
  • Collections
    • All Collections
      GET
    • Create Collection
      POST
    • Create a Fork
      POST
    • Merge a Fork
      POST
    • Delete Collection
      DELETE
    • Single Collection
      GET
    • Update Collection
      PUT
  • Environments
    • All Environments
    • Create Environment
    • Delete Environment
    • Single Environment
    • Update Environment
  • Import
    • Import exported data
    • Import external API specification
  • User
    • API Key Owner
  • Mocks
    • All Mocks
    • Create Mock
    • Delete Mock
    • Single Mock
    • Update Mock
    • Publish Mock
    • Unpublish Mock
  • Monitors
    • All Monitors
    • Create Monitor
    • Delete Monitor
    • Single Monitor
    • Update Monitor
    • Run a Monitor
  • Webhooks
    • Create Webhook
  • Workspaces
    • All workspaces
    • Create Workspace
    • Delete Workspace
    • Single workspace
    • Update Workspace
  1. API

Single API

GET
/apis/{apiId}
API
This call fetches a single API having the specified id.
Response contains an api object with all the details related to the queried API, namely, id, name, summary, description etc.
Requires API Key as X-Api-Key request header or apikey URL query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.getpostman.com/apis/'
Response Response Example
{
  "api": {
    "createdAt": "2019-02-12T19:34:49.000Z",
    "createdBy": "5665",
    "description": "This is a description.This is a description.",
    "id": "387c2863-6ee3-4a56-8210-225f774edade",
    "name": "Sync API",
    "summary": "This is a summary",
    "updatedAt": "2019-02-12T19:34:49.000Z"
  }
}

Request

Path Params
apiId
string 
required

Responses

🟢200Get single API
application/json
Body
api
object 
optional
createdAt
string 
optional
Example:
2019-02-12T19:34:49.000Z
createdBy
string 
optional
Example:
5665
description
string 
optional
Example:
This is a description.This is a description.
id
string 
optional
Example:
387c2863-6ee3-4a56-8210-225f774edade
name
string 
optional
Example:
Sync API
summary
string 
optional
Example:
This is a summary
updatedAt
string 
optional
Example:
2019-02-12T19:34:49.000Z
Modified at 2023-08-15 05:41:03
Previous
Delete an API
Next
Update an API
Built with