# Postman integration

> Postman API: manage collections, environments, workspaces, mock servers, monitors, specs, APIs, and team resources in a Postman account.

- Authentication: apiKey

## Tools (263)

- **Add a collection**: Adds a collection to an API.
- **Add a workspace**: Publishes a workspace in your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
- **Add discovered services to the API Catalog**: Adds discovered services to the API Catalog.
- **Add system environment associations**: Adds workspace-environment associations to a system environment.
- **Approve or deny an access request**: Approve or deny a team's access request.
- **Assign and unassign workspaces**: Assigns workspaces to and unassigns workspaces from a governance group.
- **Assign a ruleset**: Assigns a ruleset to a governance group.
- **Connect a Git repository to an SDK**: Connects a Postman source element (collection or specification) to a Git repository for one SDK language.
- **Create a collection**: Creates a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
- **Create a collection comment (Apis)**: Creates a comment on an API's collection.
- **Create a collection comment (Collections)**: Creates a comment on a collection.
- **Create a component**: Creates a new component.
- **Create a component version**: Publishes a new version of a component from the current draft.
- **Create a custom function**: Creates a new custom function for the team.
- **Create a folder**: Creates a folder in a collection.
- **Create a folder comment**: Creates a comment on a folder.
- **Create a fork (Collections)**: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork) from an existing collection into a workspace.
- **Create a fork (Environments)**: Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an existing environment.
- **Create a governance group**: Creates a custom governance group for the team.
- **Create a mock server**: Creates a mock server in a collection.
- **Create a monitor**: Creates a monitor.
- **Create an access request**: Creates an access request for a team.
- **Create an API**: Creates an API.
- **Create an API comment**: Creates a comment on an API.
- **Create an environment**: Creates an environment.
- **Create a package**: Creates a package and its index script as a Postman Package Library resource.
- **Create a pull request**: Creates a pull request for a forked collection into its parent collection.
- **Create a request**: Creates a request in a collection.
- **Create a request comment**: Creates a comment on a request.
- **Create a response**: Creates a request response in a collection.
- **Create a response comment**: Creates a comment on a response.
- **Create a ruleset**: Creates a new ruleset for the team.
- **Create a schema**: Creates a schema for an API.
- **Create a server response**: Creates a server response.
- **Create a spec**: Creates an API specification in Postman's [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/).
- **Create a spec file**: Creates a file for an OpenAPI or a protobuf 2 or 3 specification.
- **Create a system environment**: Creates a system environment for the authenticated team.
- **Create a team**: Creates a Postman team in your organization.
- **Create a version**: Creates a new API version asynchronously and immediately returns an HTTP 202 Accepted response.
- **Create a version tag**: Creates a version tag for a specification.
- **Create a webhook**: Creates a webhook that triggers a collection with a custom payload.
- **Create a workspace**: Creates a new workspace.
- **Create a workspace update**: Creates a workspace update in the given workspace.
- **Create or update a schema file**: Creates or updates an API schema file.
- **Delete a collection**: Deletes a collection.
- **Delete a collection access key**: Deletes a collection access key.
- **Delete a collection's comment (Apis)**: Deletes a comment from an API's collection.
- **Delete a collection's comment (Collections)**: Deletes a comment from a collection.
- **Delete a custom function**: Deletes a custom function.
- **Delete a folder**: Deletes a folder in a collection.
- **Delete a folder's comment**: Deletes a comment from a folder.
- **Delete a governance group**: Deletes a governance group.
- **Delete a mock server**: Deletes a mock server.
- **Delete a monitor**: Deletes a monitor.
- **Delete an API**: Deletes an API.
- **Delete an API's comment**: Deletes a comment from an API.
- **Delete an environment**: Deletes an environment.
- **Delete an SDK**: Deletes an SDK record and its stored archive.
- **Delete a package**: Deletes the package and its associated index script content.
- **Delete a request**: Deletes a request in a collection.
- **Delete a request's comment**: Deletes a comment from a request.
- **Delete a response**: Deletes a response in a collection.
- **Delete a response's comment**: Deletes a comment from a response.
- **Delete a ruleset**: Deletes a ruleset.
- **Delete a ruleset assignment**: Unassigns a ruleset from a governance group.
- **Delete a schema file**: Deletes a file in an API schema.
- **Delete a server response**: Deletes a mock server's server response.
- **Delete a spec**: Deletes an API specification.
- **Delete a spec file**: Deletes a file in an API specification.
- **Delete a version**: Deletes an API version.
- **Delete a workspace**: Deletes an existing workspace.
- **Delete a workspace update**: Deletes a workspace update.
- **Duplicate a collection**: Creates a duplicate of the given collection in another workspace.
- **Generate a collection from spec**: Creates a collection from the given OpenAPI 2.0, 3.0, or 3.1 specification or Smithy specification.
- **Generate an SDK**: Creates an asynchronous generation job for a single SDK (in one language) from a collection or specification.
- **Generate spec from collection**: Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection.
- **Get accounts**: Gets Postman billing account details for the given team.
- **Get a collection (Apis)**: Gets a collection attached to an API.
- **Get a collection (Collections)**: Gets information about a collection.
- **Get a collection's comments (Apis)**: Gets all comments left by users in an API's collection.
- **Get a collection's comments (Collections)**: Gets all comments left by users in a collection.
- **Get a collection's forks**: Gets a collection's forked collections.
- **Get a collection's pull requests**: Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull requests, and a URL link to the pull requests.
- **Get a collection's roles**: Gets information about all roles in a collection.
- **Get a collection's tags**: Gets all the tags associated with a collection.
- **Get a component**: Gets information about a component.
- **Get a component draft**: Gets information about the current working draft of a component, including its content and format.
- **Get a component version**: Gets a published version of a component.
- **Get a Context Graph ask**: Gets a submitted ask's status and, once the ask completes, its result.
- **Get a custom function**: Gets information about a custom function.
- **Get a discovered service's information**: Gets detailed information about a discovered service, including a base64-encoded OpenAPI specification and an array of endpoints.
- **Get a folder**: Gets information about a folder in a collection.
- **Get a folder's comments**: Gets all comments left by users in a folder.
- **Get a governance group's ruleset assignments**: Gets the rulesets assigned to a governance group.
- **Get a group**: Gets information about a Postman [user group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
- **Get all add requests**: Gets all requests to add workspaces to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
- **Get all APIs**: Gets information about all APIs in a workspace.
- **Get all audit log event actions**: Gets a complete list of all available audit log event actions.
- **Get all collections**: Gets all of your [collections](https://www.postman.com/docs/collections).
- **Get all components**: Gets a list of all components in the team's component library.
- **Get all component versions**: Gets a list of a component's published versions.
- **Get all custom functions**: Gets a list of the team's custom functions.
- **Get all environments**: Gets information about all of your [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
- **Get all forked collections**: Gets a list of all the authenticated user's forked collections.
- **Get all governance groups**: Gets a list of the team's governance groups.
- **Get all groups**: Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
- **Get all mock servers**: Gets all active mock servers.
- **Get all monitors**: Gets all monitors.
- **Get all packages**: Gets all active packages available to the authenticated user.
- **Get all roles**: Gets information about all roles in a workspace, based on the team's plan.
- **Get all rulesets**: Gets a list of the team's rulesets.
- **Get all runner instances**: Gets all instances of the runner polling Postman for upcoming monitor runs.
- **Get all SDK Git connections**: Gets all Git repository connections the authenticated user has access to in the given workspace.
- **Get all SDKs**: Lists all SDKs the authenticated user has access to.
- **Get all server responses**: Gets all of a mock server's server responses.
- **Get all services**: Gets a list of services in a system environment.
- **Get all specs**: Gets all API specifications in a workspace.
- **Get all system environments**: Gets all of the authenticated team's system environments.
- **Get all teams**: Gets all Postman teams in your organization.
- **Get all team users**: Gets information about all users on the Postman team.
- **Get all versions**: Gets all the published versions of an API.
- **Get all workspaces (Private Api Network)**: Gets information workspaces added to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
- **Get all workspaces (Workspaces)**: Gets all workspaces you have access to.
- **Get all workspace updates**: Gets a list of workspace updates for the given workspace.
- **Get a mock server**: Gets information about a mock server.
- **Get a mock server's call logs**: Gets a mock server's call logs.
- **Get a monitor**: Gets information about a monitor.
- **Get analytics data**: Gets analytics data based on the specified resource, metrics, and given filters for team, internal, and public workspaces, as well as Partner Workspaces.
- **Get analytics metadata**: Returns a catalog of analytics resources and their corresponding metrics for use with the GET /analytics endpoint.
- **Get an API**: Gets information about an API.
- **Get an API's comments**: Gets all comments left by users in an API.
- **Get an API's tags**: Gets all the tags associated with an API.
- **Get an environment**: Gets information about an environment.
- **Get an environment's forks**: Gets all of an environment's forked environments.
- **Get an SDK**: Returns information about the SDK, including the current build job status.
- **Get an SDK Git connection**: Gets information about an SDK's Git connection.
- **Get an SDK Git connection's pull requests**: Lists all SDK update pull requests for the Git connection, in order of newest first by its `updatedAt` property.
- **Get an SDK's download URL**: Gets a short-lived signed URL for the generated SDK archive (zip).
- **Get a package**: Gets an active package's metadata and its current index script content.
- **Get a pull request**: Gets information about a pull request, such as the source and destination details, who reviewed the pull request, the merge's current status, and whether the element is accessible.
- **Get a request**: Gets information about a request in a collection.
- **Get a request's comments**: Gets all comments left by users in a request.
- **Get a response**: Gets information about a response in a collection.
- **Get a response's comments**: Gets all comments left by users in a response.
- **Get a ruleset**: Gets information about a ruleset.
- **Get a schema**: Gets information about API schema.
- **Get a server response**: Gets information about a server response.
- **Get a service by ID**: Gets information about a service, including its health, traffic, compliance, ownership, and dependencies.
- **Get a service's CI runs**: Gets a paginated list of CI collection runs for a service that includes summary statistics, pipeline details, and Git metadata.
- **Get a service's endpoints**: Get a list of observed API endpoints for a service and its performance metrics.
- **Get a service's monitor runs**: Gets a list of scheduled monitor runs for a service that includes summary statistics.
- **Get a service's specification lints**: Gets a list of API specification lint runs for a service that includes summary statistics and per-severity issue counts.
- **Get a spec**: Gets information about an API specification.
- **Get a spec file**: Gets the contents of an API specification's file.
- **Get a specification's version tags**: Gets a list of a specification's version tags.
- **Get a spec's definition**: Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.
- **Get a spec's files**: Gets all the files in an API specification.
- **Get a spec's generated collections**: Gets all of an API specification's generated collections.
- **Get async collection update status**: Gets the status of an asynchronous collection update task.
- **Get a system environment**: Gets information about a system environment.
- **Get a system environment's associations**: Gets the workspace-environment associations for a system environment.
- **Get a team**: Gets information about a Postman team.
- **Get a team's access requests**: Gets a team's pending access requests.
- **Get a team's settings**: Gets a team's settings.
- **Get a team user**: Gets information about a user on the Postman team.
- **Get authenticated user**: Gets information about the authenticated user.
- **Get a version**: Gets information about an API version.
- **Get a version tag**: Gets information about a specification's version tag.
- **Get a workspace**: Gets information about a workspace.
- **Get a workspace's activity feed**: Gets a workspace's activity feed.
- **Get a workspace's roles**: Gets the roles of users, user groups, and partners in a workspace.
- **Get a workspace's tags**: Gets all the tags associated with a workspace.
- **Get a workspace update**: Gets information about a workspace update.
- **Get collection access keys**: Gets the authenticated user's personal and team [collection access keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key).
- **Get detected secrets locations**: Gets the locations of secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/).
- **Get discovered services**: Gets a list of all [discovered services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) in the API Catalog.
- **Get duplication task status**: Gets the status of a collection duplication task.
- **Get elements by tag**: Gets Postman elements (entities) by a given tag.
- **Get generated spec**: Gets the API specification generated for the given collection.
- **Get global variables**: Gets a workspace's global variables.
- **Get merge or pull task status**: Gets the status of a collection's merge or a pull changes task.
- **Get ruleset assignments**: Gets a ruleset's governance group assignments.
- **Get runner metrics**: Gets the Postman server-side metrics for a runner instance.
- **Get schema file contents**: Gets an API schema file contents at the defined path.
- **Get schema files**: Gets the files in an API schema.
- **Get secret types**: Gets the metadata of the secret types supported by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/).
- **Get source collection's status**: Checks whether there is a change between the forked collection and its parent (source) collection.
- **Get status of an asynchronous task**: Gets the status of an asynchronous task.
- **Get status of an async spec task**: Gets the status of an asynchronous API specification creation task.
- **Get status of API Builder to Spec Hub migration**: Returns the status of an API Builder definition's migration to Spec Hub.
- **Get team audit logs**: Gets a list of your team's generated audit events.
- **Get workspaces in a governance group**: Gets all workspaces assigned to the governance group.
- **Import an OpenAPI definition**: Imports an OpenAPI definition into Postman as a new [Postman Collection](https://learning.postman.com/docs/getting-started/creating-the-first-collection/).
- **List account invoices**: Gets all invoices for a Postman billing account filtered by the status of the invoice.
- **Manage Partner Workspace invites**: Manages invitations and access to your team's Partner Workspaces.
- **Manage team member roles**: Adds or removes member roles in groups, teams, organizations, and for individual users.
- **Merge a fork**: [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked environment back into its parent environment.
- **Merge or pull changes into a collection fork**: [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork) a forked (source) collection and its parent (destination) collection asynchronously.
- **Migrate API Builder API to Spec Hub**: Migrates an API Builder definition to a Spec Hub specification.
- **Publish a mock server**: Publishes a mock server.
- **Publish documentation**: Publishes a collection's documentation.
- **Pull source changes (Collections)**: Pulls the changes from a parent (source) collection into the forked collection.
- **Pull source changes (Environments)**: [Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element) the changes from a parent (source) environment into the forked environment.
- **Remove a workspace**: Removes a workspace from your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
- **Remove system environment associations**: Removes workspace-environment associations from a system environment.
- **Remove team members**: Removes entities, such as users or organizations, from your Postman team.
- **Replace a collection's data**: Replaces the contents of a collection using the [Postman Collection v2.1.0 schema format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
- **Replace an environment's data**: Replaces all the contents of an environment with the given information.
- **Resolve a comment thread**: Resolves a comment and any associated replies.
- **Respond to an add request**: Responds to a user's request to add a workspace to your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
- **Review a pull request**: Updates the [review](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/) status of a pull request.
- **Run a monitor**: Runs a monitor and returns its run results.
- **Search detected secrets**: Returns all secrets detected by Postman's [Secret Scanner](https://learning.postman.com/docs/administration/secret-scanner/), grouped by workspace or resource.
- **Search Postman resources**: Searches Postman for resources such as workspaces, collections, requests, and other resource types.
- **Submit a Context Graph ask**: Submits a natural-language question about your team's Context Graph.
- **Sync collection with schema**: Syncs a collection attached to an API with the API schema.
- **Sync collection with spec**: Syncs a collection generated from an API specification.
- **Sync spec with collection**: Syncs an API specification linked to a collection.
- **Transfer element to a workspace**: Transfers a Postman element from one workspace to another workspace.
- **Transfer folders**: Copies or moves folders into a collection or folder.
- **Transfer requests**: Copies or moves requests into a collection or folder.
- **Transfer responses**: Copies or moves responses into a request.
- **Transfer workspace to a team**: Transfers a workspace from one team (source) to another team (destination).
- **Unpublish a mock server**: Unpublishes a mock server.
- **Unpublish documentation**: Unpublishes a collection's documentation.
- **Update a collection's comment (Apis)**: Updates a comment on an API's collection.
- **Update a collection's comment (Collections)**: Updates a comment on a collection.
- **Update a collection's roles**: Updates the roles of users, groups, or teams in a collection.
- **Update a collection's tags**: Updates a collection's associated tags, replacing all existing tags.
- **Update a component**: Updates a component: - `name` — Rename the component.
- **Update a component draft**: Updates a component's draft.
- **Update a custom function**: Updates a custom function.
- **Update a folder**: Updates a folder in a collection.
- **Update a folder's comment**: Updates a comment on a folder.
- **Update a governance group**: Updates a governance group's name or description.
- **Update a mock server**: Updates a mock server's properties, such as its name or collection.
- **Update a monitor**: Updates a monitor's [configurations](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#configure-a-monitor).
- **Update an API**: Updates an API.
- **Update an API's comment**: Updates a comment on an API.
- **Update an API's tags**: Updates an API's associated tags, replacing all existing tags.
- **Update an environment**: Updates specific environment properties, such as its name and variables.
- **Update an SDK Git connection**: Updates the Git connection's lifecycle status: - `active` — Connects or reconnects the repository.
- **Update a package**: Updates a package's description and/or index script content.
- **Update a pull request**: Updates an open pull request.
- **Update a request**: Updates a request in a collection.
- **Update a request's comment**: Updates a comment on a request.
- **Update a response**: Updates a response in a collection.
- **Update a response's comment**: Updates a comment on a response.
- **Update a ruleset**: Updates a ruleset.
- **Update a server response**: Updates a server response.
- **Update a spec file**: Updates a file for an OpenAPI or protobuf 2 or 3 specification.
- **Update a spec's properties**: Updates an API specification's properties, such as its name.
- **Update a system environment**: Updates a system environment's information.
- **Update a version**: Updates an API version.
- **Update a workspace**: Updates a workspace's property, such as its name or visibility.
- **Update a workspace's tags**: Updates a workspace's associated tags, replacing all existing tags.
- **Update a workspace update**: Updates a workspace update.
- **Update detected secret resolution status**: Updates the resolution status of a secret detected in a workspace.
- **Update global variables**: Updates and replaces a workspace's global variables.
- **Update part of a collection**: Updates specific collection information, such as its name, events, or its variables.
- **Update spec sync options**: Updates the sync options for a specification's generated collection.
- **Update team settings**: Updates a team's settings.
- **Update workspace roles**: Updates the roles of users, user groups, or partners in a workspace.

Connect Postman in General Input: https://www.generalinput.com/apps/postman