Postman

Overview

Postman is an API platform for building, testing, and managing APIs with powerful collaboration features. With the Postman integration in SquadOS, your agents can automate the entire API lifecycle: create collections and requests, manage environments and variables, configure mock servers, run monitors, and import/export OpenAPI specifications.

• Official website: https://www.postman.com/
• Composio documentation: docs.composio.dev/toolkits/postman

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	Your Postman account API key, used to authenticate all requests to the Postman API.

How to get credentials

1. Go to postman.com and log in to your account.
2. Click your avatar in the top-right corner and select Settings.
3. In the API keys section, click Generate API Key.
4. Give the key a descriptive name (e.g., “SquadOS”) and confirm.
5. Copy the generated key — it is shown only once.

Tip

The Postman API key grants full access to your account. Create a dedicated key for SquadOS so you can revoke it independently without affecting other integrations.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Postman.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Note

This integration exposes 135 actions in total. The most relevant ones are listed below; see the full list in the Composio documentation.

Create a Collection

POSTMAN_CREATE_A_COLLECTION

Tool to create a new Postman collection in a specific workspace or the default workspace. Use when you need to create a collection with workspace specification.

Input parameters

Name	Type	Required	Description
workspace	string	No	Optional workspace ID where the collection will be created. If not specified, the collection is created in the user’s default workspace.
collection	object	Yes	Collection object containing info (name, description, schema) and item array (requests/folders).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Request in Collection

POSTMAN_CREATE_A_REQUEST

Tool to create a new request in a Postman collection. Use when you need to add a request to an existing collection with specified method, URL, headers, and body.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the request to create.
request	object	Yes	The request object containing method, URL, headers, body, and other request details following the Postman Collection Format.
collection_id	string	Yes	The unique identifier of the collection where the request will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Folder

POSTMAN_CREATE_A_FOLDER

Tool to create a folder in a Postman collection. Use when you need to organize requests by creating a new folder within a collection.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the folder to create.
description	string	No	Optional description of the folder explaining its purpose.
collection_id	string	Yes	The unique identifier of the collection to create the folder in.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create an Environment

POSTMAN_CREATE_AN_ENVIRONMENT

Tool to create a new environment in a Postman workspace. Use when you need to create a new environment with variables for different settings (development, production, testing, etc.).

Input parameters

Name	Type	Required	Description
environment	object	Yes	Environment object containing name and optional array of environment variables.
workspace_id	string	Yes	The workspace ID where the environment will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Workspace

POSTMAN_CREATE_A_WORKSPACE

Tool to create a new workspace in Postman with a specified name, type (personal, team, private, or public), and optional description.

Input parameters

Name	Type	Required	Description
workspace	object	Yes	The workspace object containing name, type, and optional description.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create an API

POSTMAN_CREATE_AN_API

Tool to create a new API in Postman with a name, summary, and description in your Postman workspace.

Input parameters

Name	Type	Required	Description
api	object	Yes	The API object containing name, summary, and description.
workspace_id	string	Yes	The workspace ID where the API will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Mock Server

POSTMAN_CREATE_A_MOCK_SERVER

Tool to create a new mock server in a Postman collection to simulate API endpoints for testing or development.

Input parameters

Name	Type	Required	Description
mock	object	Yes	Mock server configuration containing name, collection UID, optional environment UID, and privacy setting.
workspace	string	No	The workspace ID where the mock server should be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Monitor

POSTMAN_CREATE_A_MONITOR

Tool to create a new monitor in a specific workspace to run a collection on a schedule using cron expressions.

Input parameters

Name	Type	Required	Description
monitor	object	Yes	Monitor configuration object containing name, collection, schedule, and optional environment.
workspace	string	Yes	The workspace ID where the monitor will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create API Schema

POSTMAN_CREATE_A_SCHEMA

Tool to create a schema for an API in Postman (OpenAPI, GraphQL, Protocol Buffers, etc.). The schema can consist of single or multiple files.

Input parameters

Name	Type	Required	Description
type	string	Yes	The type of schema being created. Common values include openapi:3, openapi:2, proto, graphql.
files	array	Yes	List of files that make up the schema. Each file must have a path and content.
api_id	string	Yes	The unique identifier (UUID) of the API for which to create the schema.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Spec

POSTMAN_CREATE_A_SPEC

Tool to create an API specification in Postman’s Spec Hub. Supports various spec types including OpenAPI 3.0, OpenAPI 3.1, and AsyncAPI 2.0.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name of the API specification to create.
type	string	Yes	The type of specification. Common values include OPENAPI:3.0, OPENAPI:3.1, ASYNCAPI:2.0.
files	array	Yes	Array of files for the specification. Each file must have a path and content property.
workspace_id	string	Yes	The workspace ID where the spec will be created.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Collections

POSTMAN_GET_ALL_COLLECTIONS2

Tool to get all collections accessible to the authenticated user, including subscribed collections.

Input parameters

Name	Type	Required	Description
limit	integer	No	The maximum number of collections to return per page.
cursor	string	No	A cursor for pagination. Pass the nextCursor value from a previous response to fetch the next page.
workspace	string	No	Optional workspace ID to filter collections.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Environments

POSTMAN_GET_ALL_ENVIRONMENTS

Tool to get all environments accessible to the authenticated user with optional workspace filtering.

Input parameters

Name	Type	Required	Description
limit	integer	No	The maximum number of environments to return per page.
cursor	string	No	A cursor for pagination.
workspace	string	No	Filter by workspace ID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Workspaces

POSTMAN_GET_ALL_WORKSPACES

Tool to get all workspaces accessible to the authenticated user with optional type filtering.

Input parameters

Name	Type	Required	Description
type	string	No	Filter by workspace type: personal, team, or public.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Workspace Details

POSTMAN_GET_A_WORKSPACE

Tool to get detailed information about a specific workspace by its ID, including all collections, environments, APIs, mocks, and monitors.

Input parameters

Name	Type	Required	Description
workspace_id	string	Yes	The unique identifier of the workspace to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get API Information

POSTMAN_GET_AN_API

Tool to retrieve information about a specific API in Postman, including name, description, versions, and schemas.

Input parameters

Name	Type	Required	Description
api_id	string	Yes	The unique identifier of the API to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All APIs

POSTMAN_GET_ALL_APIS

Tool to get all APIs accessible to the authenticated user with optional workspace filtering.

Input parameters

Name	Type	Required	Description
limit	integer	No	The maximum number of APIs to return per page.
cursor	string	No	A cursor for pagination.
workspace	string	No	Filter by workspace ID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get an Environment

POSTMAN_GET_AN_ENVIRONMENT

Tool to retrieve detailed information about a specific environment, including name, ID, owner, and all environment variables.

Input parameters

Name	Type	Required	Description
environment_id	string	Yes	The unique identifier (ID or UID) of the environment to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Collection Properties

POSTMAN_UPDATE_PART_OF_A_COLLECTION

Tool to update specific collection properties like name, description, authentication, variables, or events without replacing the entire collection structure.

Input parameters

Name	Type	Required	Description
collection	object	Yes	The collection object containing the properties to update. Can include info (with name, description), auth, variables, or events.
collection_id	string	Yes	The unique identifier (ID or UID) of the collection to update.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update an Environment

POSTMAN_UPDATE_AN_ENVIRONMENT

Tool to update specific environment properties using JSON Patch operations (RFC 6902). Use when you need to modify environment name or variables without replacing the entire environment.

Input parameters

Name	Type	Required	Description
operations	array	Yes	Array of JSON Patch operations to apply to the environment. Each operation modifies a specific field using the RFC 6902 format.
environment_id	string	Yes	The unique identifier (ID or UID) of the environment to update.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update a Workspace

POSTMAN_UPDATE_A_WORKSPACE

Tool to update an existing workspace in Postman. The ‘type’ field is required for all updates.

Input parameters

Name	Type	Required	Description
workspace	object	Yes	The workspace object containing fields to update. The ‘type’ field is required; ‘name’ and ‘description’ are optional.
workspace_id	string	Yes	The unique identifier of the workspace to update.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete a Collection

POSTMAN_DELETE_A_COLLECTION

Tool to permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed.

Input parameters

Name	Type	Required	Description
collection_id	string	Yes	The unique identifier (UID or ID) of the collection to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete an Environment

POSTMAN_DELETE_AN_ENVIRONMENT

Tool to delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed.

Input parameters

Name	Type	Required	Description
environment_id	string	Yes	The environment ID or UID to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Import OpenAPI Specification

POSTMAN_IMPORT_OPENAPI

Tool to import an OpenAPI specification into Postman as a new collection within a specific workspace.

Input parameters

Name	Type	Required	Description
type	string	Yes	The type of import input. Use string when providing the OpenAPI specification as a JSON/YAML string.
input	string	Yes	The OpenAPI specification content as a JSON or YAML string. Must be a valid OpenAPI 3.0+ specification.
workspace	string	Yes	The unique identifier of the workspace where the OpenAPI specification will be imported.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Generate Collection from Spec

POSTMAN_GENERATE_A_COLLECTION_FROM_SPEC

Tool to generate a Postman collection from an OpenAPI 2.0, 3.0, or 3.1 specification. The operation is asynchronous and returns a task ID to track generation status.

Input parameters

Name	Type	Required	Description
name	string	Yes	The name for the generated collection.
options	object	No	Options for configuring the collection generation from the specification.
spec_id	string	Yes	The unique identifier of the API specification from which to generate the collection.
element_type	string	No	The type of element to generate. Must be collection for collection generation.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Transform Collection to OpenAPI

POSTMAN_TRANSFORM_COLLECTION_TO_OPENAPI

Tool to transform an existing Postman Collection into a stringified OpenAPI 3.0.3 definition. Use when you need to convert a collection to OpenAPI format for API documentation or interoperability.

Input parameters

Name	Type	Required	Description
collection_id	string	Yes	The unique identifier of the collection to transform into OpenAPI format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Run a Monitor

POSTMAN_RUN_A_MONITOR

Tool to trigger an immediate run of a monitor and retrieve its execution results. Use when you need to manually execute a monitor outside of its scheduled runs.

Input parameters

Name	Type	Required	Description
monitor_id	string	Yes	The unique identifier (ID or UID) of the monitor to run.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a Pull Request

POSTMAN_CREATE_A_PULL_REQUEST

Tool to create a pull request for a forked collection into its parent collection. The forked collection must exist before creating a pull request.

Input parameters

Name	Type	Required	Description
title	string	Yes	The title of the pull request. This should summarize the changes being proposed.
reviewers	array	No	Array of reviewer user IDs or user groups who should review the pull request.
description	string	No	A detailed description of the changes in the pull request.
collection_uid	string	Yes	The unique identifier (UID) of the forked collection from which to create the pull request. Format: {owner}-{collectionId}.
destination_id	string	Yes	The UID of the destination (parent) collection where the changes will be merged. Format: {owner}-{collectionId}.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Authenticated User

POSTMAN_GET_AUTHENTICATED_USER

Tool to get information about the authenticated user, including their user ID, username, and email address.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Monitors

POSTMAN_GET_ALL_MONITORS

Tool to get all monitors accessible to the authenticated user with optional workspace filtering.

Input parameters

Name	Type	Required	Description
limit	integer	No	The maximum number of monitors to return per page. Defaults to 25.
cursor	string	No	A cursor for pagination.
workspace	string	No	Filter by workspace ID.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.