Postman

App · 21 actions

Manage Postman workspaces, collections and environments; run monitors and inspect mock servers.

Actions

ActionWhat it does
Create collectionCreate collection.
Create environmentCreate environment.
Create workspaceCreate workspace.
Delete collectionDelete collection.
Delete environmentDelete environment.
Delete workspaceDelete workspace.
Get collectionGet collection.
Get current userGet current user.
Get environmentGet environment.
Get mockGet mock.
Get monitorGet monitor.
Get workspaceGet workspace.
List collectionsList collections.
List environmentsList environments.
List mocksList mocks.
List monitorsList monitors.
List workspacesList workspaces.
Rename collectionRename collection.
Rename environmentRename environment.
Run monitorStart a monitor in the background.
Set environment variablesSet the values of variables in a Postman environment, such as a fresh token or a new base URL, adding any it doesn't have yet.

Create collection

Create collection.

Inputs

NamenametextRequired
Name.
Workspaceworkspacetext
Workspace.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create environment

Create environment.

Inputs

NamenametextRequired
Name.
Workspaceworkspacetext
Workspace.
Valuesvalueslist
Values.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create workspace

Create workspace.

Inputs

NamenametextRequired
Name.
Workspace typeworkspace_typetextRequired
Workspace type.One of: personal, team, private, public, partner.
Descriptiondescriptiontext
Description.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete collection

Delete collection.

Inputs

Collectioncollection_idtextRequired
Collection id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete environment

Delete environment.

Inputs

Environmentenvironment_idtextRequired
Environment id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Delete workspace

Delete workspace.

Inputs

Workspaceworkspace_idtextRequired
Workspace id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get collection

Get collection.

Inputs

Collectioncollection_idtextRequired
Collection id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get current user

Get current user.

Inputs

None.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get environment

Get environment.

Inputs

Environmentenvironment_idtextRequired
Environment id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get mock

Get mock.

Inputs

Mockmock_idtextRequired
Mock id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get monitor

Get monitor.

Inputs

Monitormonitor_idtextRequired
Monitor id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get workspace

Get workspace.

Inputs

Workspaceworkspace_idtextRequired
Workspace id.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List collections

List collections.

Inputs

Workspaceworkspacetext
Workspace.
Limitlimitnumber
Limit.From 1 to 100.
Offsetoffsetnumber
Offset.At least 0.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List environments

List environments.

Inputs

Workspaceworkspacetext
Workspace.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List mocks

List mocks.

Inputs

Workspaceworkspacetext
Workspace.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List monitors

List monitors.

Inputs

Workspaceworkspacetext
Workspace.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List workspaces

List workspaces.

Inputs

Limitlimitnumber
Limit.From 1 to 100.
Cursorcursortext
Cursor.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Rename collection

Rename collection.

Inputs

Collectioncollection_idtextRequired
Collection id.
NamenametextRequired
Name.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Rename environment

Rename environment.

Inputs

Environmentenvironment_idtextRequired
Environment id.
NamenametextRequired
Name.

Outputs

Response.

dataobject
Data.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Run monitor

Start a monitor in the background. Its collection can send requests that change other services. Use Get monitor to check lastRun for the results.

Inputs

Monitormonitor_idtextRequired
The monitor to run.

Outputs

dataobject
The accepted monitor run.
has_moretrue/false
Always false.
next_cursortext
No pagination token.
Example output
{
  "data": {
    "run": {}
  },
  "has_more": false,
  "next_cursor": null
}

Set environment variables

Set the values of variables in a Postman environment, such as a fresh token or a new base URL, adding any it doesn't have yet. Other variables are left as they are, and a secret variable stays secret.

Inputs

Environmentenvironment_idtextRequired
The environment to change.
VariablesvariablesobjectRequired
Each variable's name and the value to give it. A name the environment doesn't have yet is added.

Outputs

Response.

dataobject
The environment after the change.
has_moretrue/false
Whether more records are available.
next_cursortext
Continuation token, if another page exists.
Example output
{
  "data": {
    "added": [
      "baseUrl"
    ],
    "environment": {
      "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
      "name": "Staging",
      "values": [
        {
          "enabled": true,
          "key": "baseUrl",
          "type": "default",
          "value": "https://staging.example.com"
        }
      ]
    },
    "updated": []
  },
  "has_more": false,
  "next_cursor": null
}

On this page