Postman
Source: https://runstack.engineer/docs/toolkits/postman
Collections, environments, workspaces, mocks, monitors, APIs, Spec Hub, comments, and pull requests.
Tools (126):
| Tool | Description |
|---|---|
postmanCreateACollection | Create a new Postman collection in a specific workspace or the default workspace. Use when you need to create a collection with workspace specification. For complete collection format details, refer to the Postman Collection Format documentation. |
postmanGetAllCollections | Get all collections accessible to the authenticated user. Use when you need to retrieve all your collections including subscribed collections. Returns detailed information for each collection including owner, creation/update timestamps, and visibility. |
postmanDeleteACollection | Permanently delete a collection from Postman. Use when you need to remove a collection that is no longer needed. |
postmanDuplicateACollection | Create a duplicate of a collection in another workspace. Use when you need to copy an existing collection to a different workspace. Returns an asynchronous task that can be tracked using the duplication task status endpoint. |
postmanGetDuplicationTaskStatus | Get the status of a collection duplication task. Use when you need to check whether a previously initiated collection duplication is still processing or has completed. The task ID is obtained from the duplicate-a-collection response. |
postmanForkCollection | Create a fork of a collection in a specified workspace. Use when you need to fork an existing collection to a workspace. |
postmanGetCollectionForks | Get all forks of a specific collection. Use when you need to retrieve information about who has forked a collection, including fork IDs, users, and creation dates. |
postmanGetAllForkedCollections | Retrieve all forked collections for the authenticated user. Use when you need to list or access all collections that the user has forked. |
postmanPullSourceChangesIntoFork | Pull changes from a parent (source) collection into a forked collection. Use when you need to sync a forked collection with its parent. |
postmanGetSourceCollectionStatus | Check whether there is a change between a forked collection and its parent (source) collection. Use when you need to determine if the source collection has updates that are not yet in the forked collection. This endpoint only works with forked collections; attempting to use it with regular collections will result in an error. |
postmanReplaceCollectionDataAsynchronously | Replace the entire contents of a collection asynchronously. Use when you need to completely replace a collection with new data. IMPORTANT: Include the collection's ID values in item, variable, and other nested objects to preserve them. If you do not include IDs, the endpoint removes existing items and creates new items. Returns a task to track with the async collection update status tool. |
postmanGetAsyncCollectionUpdateStatus | Get the status of an asynchronous collection update task. Use when you need to check whether a previously initiated async collection update is still processing, has completed successfully, or has failed. The task ID is obtained from PUT /collections/{collectionId} when using the Prefer: respond-async header. |
postmanTransferFolders | Copy or move folders into a collection or folder. Use when you need to reorganize collections by transferring folders between collections or into other folders. |
postmanTransformCollectionToOpenApi | 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 with other tools. |
postmanUpdateCollectionProperties | Update specific collection properties like name, description, authentication, variables, or events. Use when you need to partially update a collection without replacing the entire collection structure. Returns the updated collection information after the changes are applied. |
postmanGetCollectionRoles | Get information about all roles in a collection. Use when you need to retrieve the IDs of all users, teams, and groups with access to view or edit a collection. |
postmanGetCollectionAccessKeys | Retrieve all personal and team collection access keys for the authenticated user. Use when you need to list or manage collection access keys. Returns an array of access key objects with their IDs, tokens, status, and associated collection information. |
postmanCreateAFolder | Create a folder in a Postman collection. Use when you need to organize requests by creating a new folder within a collection. For complete details, see the Postman Collection Format documentation. |
postmanGetFolderInformation | Retrieve information about a folder in a Postman collection. Use when you need to fetch details about a specific folder including its name, description, owner, and timestamps. |
postmanUpdateAFolder | Update a folder in a Postman collection. Use when you need to modify the name or description of an existing folder. For complete properties and information, see the Postman Collection Format documentation. |
postmanDeleteAFolder | Delete a folder in a Postman collection. Use when you need to remove a folder and all its contents from a collection. The folder ID should not contain spaces to avoid 404 errors. |
postmanCreateRequestInCollection | 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. |
postmanGetRequestInformation | Retrieve information about a specific request in a Postman collection. Use when you need to fetch details about a request including its method, URL, headers, body, authentication, and associated scripts. |
postmanUpdateRequestInCollection | Update a request in a Postman collection. Use when you need to modify an existing request's name, method, URL, headers, or body following the Postman Collection Format. |
postmanCreateAResponse | Create a request response in a Postman collection. Use when you need to add a saved response example to a specific request in a collection. |
postmanGetResponseInformation | Retrieve information about a saved response in a Postman collection. Use when you need to fetch details about a specific response including status, headers, body, and metadata. |
postmanUpdateAResponse | Update a response in a Postman collection. Use when you need to modify properties of an existing saved response example such as name, status, code, headers, cookies, or body. |
postmanDeleteAResponse | Delete a response in a Postman collection. Use when you need to remove a saved response from a collection. |
postmanGetCollectionPullRequests | Get information about a collection's pull requests including source and destination IDs, status, and URLs. Use when you need to retrieve pull request details for a specific collection. |
postmanCreateAPullRequest | Create a pull request for a forked collection into its parent collection. Use when you need to propose changes from a forked collection to be merged into the parent collection. The forked collection must exist before creating a pull request. |
postmanUpdateAPullRequest | Update an open pull request in Postman. Use when you need to modify the title, description, or reviewers of an existing pull request. |
postmanReviewAPullRequest | Update the review status of a pull request by approving, declining, merging, or unapproving it. Use when you need to perform a review action on a Postman pull request. |
postmanCreateACollectionComment | Create a comment on an API's collection. Use when you need to add a comment to a specific collection within an API. To create a reply on an existing comment, include the thread ID in the request. |
postmanGetCollectionComments | Retrieve all comments left by users in an API's collection. Use when you need to fetch all comments associated with a specific collection within an API. |
postmanDeleteACollectionsComment | Delete a comment from an API's collection. Use when you need to remove a specific comment from a collection. |
postmanGetApiComments | Retrieve all comments left by users in an API. Use when you need to fetch all comments associated with a specific API. |
postmanUpdateAnApisComment | Update a comment on an API. Use when you need to modify the text content of an existing comment on a specific API. |
postmanDeleteAnApisComment | Delete a comment from an API. Use when you need to remove a comment from a specific API. On success, returns HTTP 204 No Content. |
postmanCreateAFolderComment | Create a comment on a folder. Use when you need to add a comment to a specific folder in a collection. |
postmanGetFolderComments | Retrieve all comments left by users in a folder. Use when you need to fetch all comments associated with a specific folder within a collection. |
postmanUpdateAFoldersComment | Update a comment on a folder. Use when you need to modify the text content of an existing comment on a specific folder in a collection. |
postmanDeleteAFoldersComment | Delete a comment from a folder. Use when you need to remove a specific comment from a folder. Returns HTTP 204 No Content on successful deletion. |
postmanCreateARequestComment | Create a comment on a request. Use when you need to add a comment to a specific request within a collection or reply to an existing comment thread. |
postmanGetRequestComments | Retrieve all comments left by users in a request. Use when you need to fetch all comments associated with a specific request within a collection. |
postmanUpdateARequestsComment | Update a comment on a request. Use when you need to modify the text content of an existing comment on a specific request within a collection. |
postmanDeleteARequestsComment | Delete a comment from a request. Use when you need to remove a specific comment from a request. On success, returns HTTP 204 No Content. |
postmanCreateAResponseComment | Create a comment on a response. Use when you need to add a comment to a specific response within a collection or reply to an existing comment thread. |
postmanGetResponseComments | Retrieve all comments left by users in a response. Use when you need to fetch all comments associated with a specific response within a collection. |
postmanUpdateAResponsesComment | Update a comment on a response. Use when you need to modify the text content of an existing comment on a specific response within a collection. |
postmanDeleteAResponsesComment | Delete a comment from a response. Use when you need to remove a specific comment from a collection response. On success, returns HTTP 204 No Content. |
postmanResolveACommentThread | Resolve a comment thread and any associated replies. Use when you need to mark a comment thread as resolved. On success, returns HTTP 204 No Content. |
postmanCreateAnEnvironment | 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.). Returns the created environment ID, name, and UID. |
postmanGetAllEnvironments | Get all environments accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve environments from Postman. Returns an array of environment objects with their IDs, names, and UIDs. |
postmanGetAnEnvironment | Retrieve detailed information about a specific environment in Postman. Use when you need to fetch environment details including name, ID, owner, and all environment variables. |
postmanDeleteAnEnvironment | Delete an environment permanently in Postman. Use when you need to remove an environment that is no longer needed. |
postmanReplaceAnEnvironmentsData | Completely replace an environment's data with new variables and values. Use when you need to update an entire environment by replacing all its contents. This operation replaces ALL existing variables with the ones provided in the request. |
postmanUpdateAnEnvironment | 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. |
postmanCreateEnvironmentFork | Create a fork from an existing environment into a workspace. Use when you need to fork an environment to a specified workspace. |
postmanGetEnvironmentForks | Retrieve all forked environments for a specific environment. Use when you need to list all environments that have been forked from a particular environment. |
postmanMergeAForkedEnvironment | Merge a forked environment back into its parent environment. Use when you need to merge changes from a forked environment into the parent. |
postmanCreateAWorkspace | Create a new workspace in Postman. Use when you need to create a workspace with a specified name, type (personal, team, private, or public), and optional description. Returns the created workspace ID, name, and type. |
postmanGetAllWorkspaces | Get all workspaces accessible to the authenticated user with optional type filtering. Use when you need to list or retrieve workspaces from Postman. Returns an array of workspace objects with their IDs, names, and types. |
postmanGetWorkspaceDetails | Get detailed information about a specific workspace by its ID. Use when you need to retrieve the complete structure of a workspace including all collections, environments, APIs, mocks, and monitors. |
postmanUpdateAWorkspace | Update an existing workspace in Postman. Use when you need to modify the name, type, or description of a workspace. The 'type' field is required for all updates. |
postmanDeleteAWorkspace | Delete a Postman workspace permanently. Use when you need to remove a workspace and all its contents. Deletion is permanent and cannot be undone. |
postmanGetWorkspaceActivityFeed | Get a workspace's activity feed showing who added or removed collections, environments, or elements, and users joining or leaving. Use when you need to track workspace changes and user activity. |
postmanGetWorkspaceRoles | Get the roles of users, user groups, and partners in a workspace. Use when you need to retrieve role assignments and understand who has what level of access to a specific workspace. |
postmanGetWorkspaceGlobalVariables | Get a workspace's global variables. Use when you need to retrieve global variables that are available throughout a workspace for access between collections, requests, scripts, and environments. Note that this endpoint only works with personal or team workspaces, not public workspaces. |
postmanUpdateWorkspaceGlobalVariables | Update and replace a workspace's global variables. Use when you need to set or replace all global variables in a workspace. Note: This endpoint replaces all existing global variables with the provided list. |
postmanCreateAnApi | Create a new API in Postman. Use when you need to create an API with a name, summary, and description in your Postman workspace. |
postmanGetAllApis | Get all APIs accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve APIs from Postman. Returns an array of API objects with their IDs, names, summaries, and other metadata. |
postmanGetApiInformation | Retrieve information about a specific API in Postman. Use when you need to fetch API details including name, description, versions, and schemas. |
postmanUpdateAnApi | Update an existing API in Postman. Use when you need to modify the name, summary, or description of an API. |
postmanDeleteAnApi | Delete an API from Postman. Use when you need to permanently remove an API. On success, returns HTTP 204 No Content. |
postmanGetAllApiVersions | Get all published versions of a specific API in Postman. Use when you need to list or retrieve version information for an API. Returns an array of version objects with their IDs and names. |
postmanGetApiVersion | Get information about a specific API version in Postman. Use when you need to retrieve details about a particular version of an API. Returns version details including ID, name, creation date, and associated schemas. |
postmanCreateApiSchema | Create a schema for an API in Postman. Use when you need to add a schema definition (such as OpenAPI, GraphQL, or Protocol Buffers) to an existing API. The schema can consist of single or multiple files. Returns the created schema ID and metadata. |
postmanGetApiSchema | Retrieve information about an API schema from Postman. Use when you need to fetch schema details for a specific API. Optionally specify a version ID to get a schema published in a specific API version. |
postmanGetSchemaFiles | Retrieve files in an API schema from Postman. Use when you need to list or view schema files for a specific API and schema ID. Optionally filter by version ID to get files from a particular API version. |
postmanGetSchemaFileContents | Get the contents of an API schema file at a specified path. Use when you need to retrieve the actual content of a schema file. Optionally specify a version ID to get file contents from a specific API version. |
postmanCreateOrUpdateASchemaFile | Create or update an API schema file in Postman. Use when you need to add a new schema file or modify an existing one within an API schema. If the provided file path exists, the file is updated; otherwise a new file is created. If the path contains slashes, folders are created. |
postmanDeleteASchemaFile | Delete a file in an API schema. Use when you need to remove a specific file from a schema. On success, returns HTTP 204 No Content. |
postmanSyncCollectionWithSchema | Sync a collection attached to an API with the API schema. This is an asynchronous endpoint that returns HTTP 202 Accepted. Use when you need to synchronize a collection with changes made to the API schema. The collection must already be attached to the API. Returns a task ID that can be used to check the status of the sync operation. |
postmanCreateApiVersionRelations | Create new relations for an API version. Use when you need to link collections or mock servers to an API version as contract tests, test suites, documentation, or mocks. |
postmanGetAllLinkedRelations | Retrieve all linked relations for a specific API version in Postman. Use when you need to discover what collections, documentation, mocks, or monitors are linked to an API version. |
postmanGetUnclassifiedRelations | Get unclassified relations for an API version in Postman. Use when you need to retrieve unclassified relations for a specific API version. This endpoint is for Postman v10 and higher. |
postmanCreateASpec | Create an API specification in Postman's Spec Hub. Use when you need to create single or multi-file specifications in a workspace. Supports various spec types including OpenAPI 3.0, OpenAPI 3.1, and AsyncAPI 2.0. |
postmanGetAllApiSpecifications | Get all API specifications in a workspace. Use when you need to list or retrieve API specs from a specific Postman workspace. Returns an array of spec objects with their IDs, names, types, and timestamps, along with pagination metadata. |
postmanGetApiSpecification | Retrieve information about an API specification in Postman. Use when you need to fetch spec details including name, type, and timestamps. |
postmanDeleteASpec | Delete an API specification from Postman. Use when you need to permanently remove a specification. On success, returns HTTP 204 No Content. |
postmanUpdateSpecProperties | Update an API specification's properties such as its name. Use when you need to modify metadata of an existing spec. |
postmanCreateSpecFile | Create a new file in an API specification. Use when you need to add a new file (such as schema definitions, path configurations, or components) to an existing spec. |
postmanGetSpecFileContents | Get the contents of an API specification's file. Use when you need to retrieve the actual content and metadata of a specific file within a spec. |
postmanUpdateSpecFile | Update an API specification file's content. Use when you need to modify the contents of a specific file within a spec. |
postmanDeleteSpecFile | Delete a file from an API specification. Use when you need to remove a specific file from a multi-file specification. |
postmanGetSpecificationFiles | Retrieve all files in an API specification from Postman. Use when you need to list or view specification files for a specific spec ID. Returns file metadata including IDs, names, paths, types, and timestamps. |
postmanGetSpecDefinition | Get the complete contents of an API specification's definition. Use when you need to retrieve the full OpenAPI/Swagger specification content for a spec. Returns the raw definition content as a string. |
postmanGetSpecsGeneratedCollections | Retrieve all collections generated from an API specification in Postman. Use when you need to fetch collections that have been auto-generated from a spec. Returns metadata and an array of generated collections. |
postmanGenerateCollectionFromSpec | Generate a Postman collection from an OpenAPI 2.0, 3.0, or 3.1 specification. Use when you need to create a collection from an existing API spec. The operation is asynchronous and returns a task ID and polling URL to check the generation status. |
postmanGenerateSpecFromCollection | Generate an API specification from a Postman collection. Use when you need to create an OpenAPI 3.0 specification from an existing collection. The operation is asynchronous and returns a task ID and polling URL to check the generation status. |
postmanGetGeneratedSpec | Retrieve the API specification generated for a Postman collection. Use when you need to fetch OpenAPI/Swagger specs that have been auto-generated from a collection. Returns metadata and an array of generated specifications. |
postmanSyncCollectionWithSpec | Sync a collection generated from an API specification. This is an asynchronous operation that returns HTTP 202 Accepted. Use when you need to update a collection to match the latest version of its source API specification. The collection must have been generated from a spec. |
postmanSyncSpecWithCollection | Sync an API specification with a linked collection. This is an asynchronous operation that returns HTTP 202 Accepted with task tracking information. Use when you need to synchronize changes from a spec to its generated collection. Prerequisites: the collection must be generated from the spec, and the spec must be single-file. |
postmanImportOpenApiSpecification | Import an OpenAPI specification into Postman as a new collection. Use when you need to convert an OpenAPI 3.0+ specification into a Postman collection within a specific workspace. The imported specification is automatically converted to a Postman collection with all endpoints, request parameters, and documentation. |
postmanCreateAMockServer | Create a new mock server in a Postman collection. Use when you need to create a mock server to simulate API endpoints for testing or development. Returns the created mock server's details including the mockUrl which can be used to make requests. |
postmanGetAllMockServers | Get all active mock servers accessible to the authenticated user. Use when you need to list or retrieve mock servers from Postman. By default, returns only mock servers you created across all workspaces. Can be filtered by workspace ID. |
postmanUpdateAMockServer | Update an existing mock server. Use when you need to change a mock server's name, description, collection, environment, or privacy settings. |
postmanPublishAMockServer | Publish a mock server in Postman. Use when you need to make a mock server publicly accessible. Publishing sets the mock server's Access Control configuration to public. |
postmanCreateMockServerResponse | Create a server response on a Postman mock server. Use when you need to simulate 5xx server-level responses (500, 503, etc.) for testing error conditions. |
postmanUpdateAServerResponse | Update a mock server's server response. Use when you need to modify properties of an existing server response such as name, status code, language, body, or headers. At least one property must be included in the update request. |
postmanDeleteMockServerResponse | Delete a mock server's server response. Use when you need to remove a specific response from a Postman mock server. |
postmanCreateAMonitor | Create a new monitor in a specific workspace to run a collection on a schedule. Use when you need to set up automated collection runs at specified intervals using cron expressions within a workspace. |
postmanGetAllMonitors | Get all monitors accessible to the authenticated user with optional workspace filtering. Use when you need to list or retrieve monitors from Postman. Returns an array of monitor objects with their IDs, names, and UIDs. |
postmanGetMonitorInformation | Retrieve information about a specific monitor in Postman. Use when you need to fetch monitor details including schedule, collection, environment, and run status. |
postmanUpdateAMonitor | Update an existing monitor in Postman. Use when you need to modify monitor properties like name, active status, collection, environment, options, notifications, or distribution settings. |
postmanDeleteMonitor | Delete a monitor by its ID. Use when you need to permanently remove a monitor from Postman. |
postmanRunAMonitor | 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. |
postmanGetAllTeamUsers | Get information about all users on the Postman team. Use when you need to list all team members and their details including roles and join dates. Returns an array of user objects with their IDs, names, usernames, emails, roles, and join timestamps. |
postmanGetATeamUser | Get information about a user on the Postman team. Use when you need to retrieve details about a specific team member including their ID, name, email, roles, and join date. |
postmanGetAuthenticatedUser | Get information about the authenticated user. Use when you need to retrieve details about the current authenticated user, including their user ID, username, and email address. |
postmanGetAllGroups | Get all user groups in a Postman team. Use when you need to list all groups and their details including member counts and timestamps. Returns an array of group objects with their IDs, names, team IDs, user counts, and creation/update timestamps. |
postmanGetResourceTypes | Get all resource types supported by Postman's SCIM API. Use when you need to discover what resource types (e.g., User, Group) are available in the SCIM API and their corresponding endpoints and schemas. |
postmanGetServiceProviderConfiguration | Get Postman's SCIM API service provider configuration information. Use when you need to discover supported SCIM operations, capabilities, and authentication schemes. Returns configuration details including support for PATCH, bulk operations, filtering, sorting, and ETag handling. |
postmanGetBillingAccountDetails | Retrieve Postman billing account details for the authenticated team. Use when you need to access account information such as account ID, team ID, account state, billing slots, sales channel, or billing email. |
postmanListAccountInvoices | Get all invoices for a Postman billing account filtered by status. Use when you need to retrieve invoice history for an account. The account ID must first be obtained from the billing accounts endpoint. |
postmanCreateAWebhook | Create a webhook that triggers a collection with a custom payload. Use when you need to set up a webhook endpoint that can trigger a Postman collection run. The webhook URL is available in the webhookUrl property of the response. |