---
title: "Postman Integration"
description: "Manage Postman workspaces, collections, and environments via the Postman API"
---
The Postman integration provides access to manage Postman workspaces, collections, and environments via the Postman API through the Integrate MCP server.

## Installation

The Postman integration is included with the SDK:

```typescript
import { postmanIntegration } from "integrate-sdk/server";
```

## Setup

Add Postman to your server configuration. Provide credentials via environment variables or integration config:

```typescript
import { createMCPServer, postmanIntegration } from "integrate-sdk/server";

export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    postmanIntegration({
      // See configuration options below
    }),
  ],
});
```

### Client-Side Usage

```typescript
import { client } from "integrate-sdk";

const result = await client.postman.getMe({});

console.log(result);
```

## Environment Variables

- `POSTMAN_API_KEY` (when supported by this integration)

## Configuration Options

<AutoTypeTable
  path="../src/integrations/postman.ts"
  name="PostmanIntegrationOptions"
/>


## Tools

### `postman_get_me`

Get me

_No parameters._

### `postman_list_workspaces`

List workspaces

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanListWorkspacesParams"
/>

### `postman_get_workspace`

Get workspace

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanGetWorkspaceParams"
/>

### `postman_list_collections`

List collections

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanListCollectionsParams"
/>

### `postman_get_collection`

Get collection

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanGetCollectionParams"
/>

### `postman_delete_collection`

Delete collection

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanDeleteCollectionParams"
/>

### `postman_list_environments`

List environments

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanListEnvironmentsParams"
/>

### `postman_get_environment`

Get environment

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanGetEnvironmentParams"
/>

### `postman_create_collection`

Create collection

<AutoTypeTable
  path="generated/tool-params/postman.ts"
  name="PostmanCreateCollectionParams"
/>

## Notes

- Category: Engineering
- Authentication mode: API key