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

Get all APIs

GET
/apis
This call fetches all the APIs present in the specified workspace
Response contains an array named apis which would contain all the details of APIs present in the workspace.
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
{}

Request

Query Params
workspace
string 
optional
Only return APIs that are inside the given workspace.
since
string 
optional
Only return APIs that have been updated after this time. Time is represented using the ISO 8601 date and time format.
until
string 
optional
Only return APIs that have been updated before this time. Time is represented using the ISO 8601 date and time format.
createdBy
string 
optional
Only return APIs that have been created by the user ID represented by the given value.
updatedBy
string 
optional
Only return APIs that have been updated by the user ID represented by the given value.
isPublic
string 
optional
Only return APIs with the corresponding privacy state. Public APIs have the isPublic value true; private APIs have the isPublic value false.
name
string 
optional
Only return APIs whose name includes the given value. Matching is case insensitive.
summary
string 
optional
Only return APIs whose summary includes the given value. Matching is case insensitive.
description
string 
optional
Only return APIs whose description includes the given value. Matching is case insensitive.
sort
string 
optional
The value of sort can be one of the names of the fields included in the response.
direction
string 
optional
The sorting direction, which can be ascending or descending. The value can be asc to specify an ascending direction or desc to specify a descending direction. If none is specified, the default sorting direction is descending for timestamp and numeric fields and ascending otherwise. An ID is not considered a numeric field.

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2023-08-15 05:41:03
Next
Create API
Built with