Postman

Gets a complete list of all available audit log event actions.

Gets a list of your team’s generated audit events. For a complete list of all audit events, see Audit logs.

Merges a forked (source) collection and its parent (destination) collection asynchronously.

Creates a fork from an existing collection into a workspace.

Creates a pull request for a forked collection into its parent collection.

Creates a collection using the Postman Collection v2.1.0 schema format.

Deletes a Postman collection by its ID, permanently removing its folders, requests and saved responses.

Creates a duplicate of the given collection in another workspace. Use the GET /collection-duplicate-tasks/{taskId} end…

Gets a collection’s forked collections. The response returns data for each fork, such as the fork’s ID, the user who for…

Gets information about a collection’s pull requests, such as the source and destination IDs, status of the pull requests…

Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups with acce…

Gets information about a collection. For a complete list of this endpoint’s possible values, refer to the Postman Collec…

Gets a list of all the authenticated user’s forked collections.

Gets all of your collections. The response includes all of your subscribed collections.

Checks whether there is a change between the forked collection and its parent (source) collection.

Updates specific collection information, such as its name, events, or its variables.

Publishes a collection’s documentation. This makes it publicly available to anyone with the link to the documentation.

Pulls the changes from a parent (source) collection into the forked collection.

Replaces the contents of a collection using the Postman Collection v2.1.0 schema format.

Copies or moves folders into a collection or folder.

Copies or moves requests into a collection or folder.

Copies or moves responses into a request.

Unpublishes a collection’s documentation. On success, this returns an HTTP 204 No Content response.

Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP 204 No Content response…

Creates a comment on a folder. To create a reply on an existing comment, include the threadId property in the request…

Deletes a comment from a folder. On success, this returns an HTTP 204 No Content response.

Gets all comments left by users in a folder in Postman, returning the Postman API response unchanged.

Updates a comment on a folder. Note: This endpoint accepts a max of 10,000 characters.

Creates a comment on a request. To create a reply on an existing comment, include the threadId property in the request…

Deletes a comment from a request. On success, this returns an HTTP 204 No Content response.

Gets all comments left by users in a request.

Updates a comment on a request. Note: This endpoint accepts a max of 10,000 characters.

Creates a comment on a response. To create a reply on an existing comment, include the threadId property in the reques…

Deletes a comment from a response. On success, this returns an HTTP 204 No Content response.

Gets all comments left by users in a response.

Updates a comment on a response. Note: This endpoint accepts a max of 10,000 characters.

Creates a comment on a collection. To create a reply on an existing comment, include the threadId property in the requ…

Deletes a comment from a collection. On success, this returns an HTTP 204 No Content response.

Gets all comments left by users in a collection.

Updates a comment on a collection. Note: This endpoint accepts a max of 10,000 characters.

Resolves a comment and any associated replies. On success, this returns an HTTP 204 No Content response.

Creates an environment. Note: - The request body size cannot exceed the maximum allowed size of 30MB.

Deletes an environment in Postman, returning the Postman API response unchanged.

Creates a fork of an existing environment in Postman, returning the Postman API response unchanged.

Gets all of an environment’s forked environments.

Gets information about an environment in Postman, returning the Postman API response unchanged.

Gets information about all of your environments.

Merges a forked environment back into its parent environment.

Updates specific environment properties, such as its name and variables.

Pulls the changes from a parent (source) environment into the forked environment.

Replaces all the contents of an environment with the given information.

Creates a folder in a collection. For a complete list of properties, refer to the Folder entry in the Postman Collection…

Deletes a folder in a collection in Postman, returning the Postman API response unchanged.

Gets information about a folder in a collection.

Updates a folder in a collection. For a complete list of properties, refer to the Folder entry in the Postman Collection…

List the groups of the Postman team.

Get one Postman group by ID.

Get the current Postman connection’s unified credentials and identity.

List unified groups in the Postman team.

Get a unified Postman group by ID.

List unified users in the Postman team.

Get a unified Postman team user by ID.

Creates a mock server in a collection. Note: - You cannot create mocks for collections added to an API definition.

Deletes a mock server in Postman, returning the Postman API response unchanged.

Gets a mock server’s call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs, whichever limit…

Gets information about a mock server in Postman, returning the Postman API response unchanged.

Gets all active mock servers. By default, this endpoint returns only mock servers you created across all workspaces.

Publishes a mock server. Publishing a mock server sets its Access Control configuration setting to public.

Unpublishes a mock server. Unpublishing a mock server sets its Access Control configuration setting to private.

Updates a mock server’s properties, such as its name or collection.

Creates a monitor. Note: - You cannot create monitors for collections added to an API definition.

Deletes a monitor in Postman, returning the Postman API response unchanged.

Gets information about a monitor in Postman, returning the Postman API response unchanged.

Gets all monitors in Postman, returning the Postman API response unchanged.

Runs a monitor and returns its run results. Note: * If you pass the async=true query parameter, the response does not…

Updates a monitor’s configurations in Postman, returning the Postman API response unchanged.

Creates a request in a collection. For a complete list of properties, refer to the Request entry in the Postman Collecti…

Deletes a request in a collection in Postman, returning the Postman API response unchanged.

Gets information about a request in a collection.

Updates a request in a collection. For a complete list of properties, refer to the Request entry in the Postman Collecti…

Creates a request response in a collection. For a complete list of request body properties, refer to the Response entry…

Deletes a response in a collection in Postman, returning the Postman API response unchanged.

Gets information about a response in a collection.

Updates a response in a collection. For a complete list of properties, see the Postman Collection Format documentation.

Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503.

Deletes a mock server’s server response in Postman, returning the Postman API response unchanged.

Gets information about a server response in Postman, returning the Postman API response unchanged.

Gets all of a mock server’s server responses.

Updates a server response in Postman, returning the Postman API response unchanged.

Creates a file for an OpenAPI or a protobuf 2 or 3 specification. Note: - If the file path contains a / (forward slash…

Creates a version tag for a specification. Version tags are snapshots of a specification at a point in time that let you…

Creates an API specification in Postman’s Spec Hub. Specifications can be single or multi-file.

Deletes a file in an API specification. On success, this returns an HTTP 204 No Content response.

Deletes an API specification. On success, this returns an HTTP 204 No Content response.

Creates a collection from the given OpenAPI 2.0, 3.0, or 3.1 specification or Smithy specification.

Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection.

Gets all API specifications in a workspace in Postman, returning the Postman API response unchanged.

Gets the API specification generated for the given collection.

Gets all of an API specification’s generated collections.

Gets the complete contents of an OpenAPI or AsyncAPI specification’s definition.

Gets the contents of an API specification’s file.

Gets all the files in an API specification in Postman, returning the Postman API response unchanged.

Gets information about a specification’s version tag. The response returns a snapshot of a specification at a point in t…

Gets a list of a specification’s version tags.

Gets information about an API specification in Postman, returning the Postman API response unchanged.

Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP `202 Accep…

Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP 202 Accepted…

Updates a file for an OpenAPI or protobuf 2 or 3 specification. Note: - This endpoint does not accept an empty request b…

Updates an API specification’s properties, such as its name.

Updates the sync options for a specification’s generated collection.

Gets all the tags associated with a collection.

Gets Postman elements (entities) by a given tag. Tags enable you to organize and search workspaces, APIs, and collection…

Gets all the tags associated with a workspace.

Updates a collection’s associated tags. This endpoint replaces all existing tags with those you pass in the request body…

Updates a workspace’s associated tags. This endpoint replaces all existing tags with those you pass in the request body.

Gets the status of a collection’s merge or a pull changes task. Note: After a merge’s success or failure, the task’s sta…

Gets the status of an asynchronous collection update task.

Gets the status of a collection duplication task.

Gets the status of an asynchronous API specification creation task.

List the Postman teams in the organization.

Get one Postman team by ID.

List the pending access requests of a Postman team.

Approve or deny a team’s access request in Postman, returning the Postman API response unchanged.

Creates an access request for a team. Access requests include actions such as request to join a team, upgrading a user’s…

Creates a Postman team in your organization in Postman, returning the Postman API response unchanged.

Gets a team’s settings in Postman, returning the Postman API response unchanged.

Adds or removes member roles in groups, teams, organizations, as well as individual users’ roles.

Removes entities, such as users or organizations, from your Postman team.

Updates a team’s settings in Postman, returning the Postman API response unchanged.

Updates a Postman team’s name in your organization. Note: You can only update the team’s name.

Creates a workspace update in the given workspace. Workspace updates keep workspace watchers informed about changes, suc…

Deletes a workspace update. On success, this returns an HTTP 204 No Content response.

Gets information about a workspace update in Postman, returning the Postman API response unchanged.

Gets a list of workspace updates for the given workspace.

Updates a workspace update. Note: This endpoint requires the application/merge-patch+json Content-Type header.

Get the Postman user that owns the API key.

List the users of the Postman team.

Get one user of the Postman team by ID.

Creates a webhook that triggers a collection with a custom payload. You can get the webhook’s URL from the webhookUrl…

Creates a new workspace. Note: - This endpoint returns a 403 Forbidden response if the user does not have permission t…

Deletes an existing workspace in Postman, returning the Postman API response unchanged.

Gets information about all roles in a workspace, based on the team’s plan.

Gets a workspace’s activity feed. Activity feeds return information about who added or removed collections, environments…

Gets a workspace’s global variables. Global variables enable you to access data between collections, requests, scripts,…

Gets the roles of users, user groups, and partners in a workspace. Note: Partner roles don’t support SCIM IDs.

Gets information about a workspace. Note: This endpoint’s response contains the visibility field.

Gets all workspaces. The response includes your workspaces and any workspaces that you have access to.

Manages invitations and access to your team’s Partner Workspaces. You can use this endpoint to: - Send Partner Workspace…

Transfers a Postman element from one workspace to another workspace. Supported elements include collections, environment…

Transfers a workspace from one team (source) to another team (destination).

Updates and replaces a workspace’s global variables. This endpoint replaces all existing global variables with the varia…

Updates the roles of users, user groups, or partners in a workspace. To get a list of roles, use the GET `/workspace-rol…

Updates a workspace’s property, such as its name or visibility.