DevTools

Postman

Postman is where teams keep their API collections, environments, monitors and API definitions.

Authentication

  • API key

Actions

Generic API request. Call any Postman API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Create collectionCreate an empty Postman collection in a workspace, ready for requests to be added from the Postman app or later API calls.
  • Create environmentCreate a Postman environment — a named set of variables such as a base URL or token — in a workspace.
  • Get authenticated userRead the Postman user the connection's API key belongs to, together with that account's usage against each plan limit.
  • Get collectionRead a Postman collection in full — its info block and the tree of folders and requests, in Postman Collection v2.1 format.
  • Get environmentRead one Postman environment with all of its variables.
  • Get workspaceRead one Postman workspace and an inventory of what lives in it.
  • List APIsList the API definitions (Postman's API Builder) in one workspace.
  • List collectionsList the Postman collections the connection can see, optionally only those in one workspace.
  • List environmentsList the Postman environments the connection can see, optionally only those in one workspace.
  • List monitorsList Postman monitors — scheduled runs of a collection against an environment.
  • List workspacesList the Postman workspaces the connection's user can see — personal, team, private, public and partner.
  • Run monitorDestructiveRun a Postman monitor now, outside its schedule, and get the result.
  • Update collectionDestructiveRename a Postman collection or change its description, leaving its folders, requests, variables and scripts untouched.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.