Postman
App · 21 actions
Manage Postman workspaces, collections and environments; run monitors and inspect mock servers.
Actions
| Action | What it does |
|---|---|
| Create collection | Create collection. |
| Create environment | Create environment. |
| Create workspace | Create workspace. |
| Delete collection | Delete collection. |
| Delete environment | Delete environment. |
| Delete workspace | Delete workspace. |
| Get collection | Get collection. |
| Get current user | Get current user. |
| Get environment | Get environment. |
| Get mock | Get mock. |
| Get monitor | Get monitor. |
| Get workspace | Get workspace. |
| List collections | List collections. |
| List environments | List environments. |
| List mocks | List mocks. |
| List monitors | List monitors. |
| List workspaces | List workspaces. |
| Rename collection | Rename collection. |
| Rename environment | Rename environment. |
| Run monitor | Start a monitor in the background. |
| 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. |
Create collection
Create collection.
Inputs
- Name
nametextRequired - Name.
- Workspace
workspacetext - 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
- Name
nametextRequired - Name.
- Workspace
workspacetext - Workspace.
- Values
valueslist - 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
- Name
nametextRequired - Name.
- Workspace type
workspace_typetextRequired - Workspace type.One of:
personal,team,private,public,partner. - Description
descriptiontext - 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
- Collection
collection_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
- Environment
environment_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
- Workspace
workspace_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
- Collection
collection_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
- Environment
environment_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
- Mock
mock_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
- Monitor
monitor_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
- Workspace
workspace_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
- Workspace
workspacetext - Workspace.
- Limit
limitnumber - Limit.From 1 to 100.
- Offset
offsetnumber - 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
- Workspace
workspacetext - 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
- Workspace
workspacetext - 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
- Workspace
workspacetext - 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
- Limit
limitnumber - Limit.From 1 to 100.
- Cursor
cursortext - 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
- Collection
collection_idtextRequired - Collection id.
- Name
nametextRequired - 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
- Environment
environment_idtextRequired - Environment id.
- Name
nametextRequired - 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
- Monitor
monitor_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
- Environment
environment_idtextRequired - The environment to change.
- Variables
variablesobjectRequired - 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
}