Skip to content

Postman

Give API context to your coding agents.

FamilyCategorySub-typeAuth typeTrending score
Developer Platformdeveloperapi-platformapi_key87

Overview

Product URLAPI docsSupported features
https://www.postman.com/https://learning.postman.com/docs/developer/intro-api/tool_discovery, health_check

Setup

  1. Install the connector instance.
  2. Store the provider token or connection secret.
  3. Sync the tools and test the connection.
  4. Review approval-gated write tools before running them.

Auth & Configuration

  • Provide a Postman API key in the X-Api-Key credential slot.

Available Tools

ToolRequires approvalDescription
list_workspacesNoList Postman workspaces.
list_collectionsNoList Postman collections.
list_environmentsNoList Postman environments.
get_collectionNoRetrieve a Postman collection by ID.

Use list_workspaces for the main execution example below because it is safe to run without approval.

Examples

Install

bash
chainabit connectors install postman --name "Postman"
bash
curl -X POST "$BASE_URL/connectors/instances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "connectorKey": "postman",
  "displayName": "Postman"
}'
javascript
const response = await fetch(`${BASE_URL}/connectors/instances`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "connectorKey": "postman",
  "displayName": "Postman"
}),
});

Credentials

bash
chainabit connectors auth <instance-id>
bash
curl -X POST "$BASE_URL/connectors/instances/<instance-id>/credentials" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "credType": "api_key",
  "credentials": {
    "apiKey": "YOUR_API_KEY"
  }
}'
javascript
await fetch(`${BASE_URL}/connectors/instances/<instance-id>/credentials`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "credType": "api_key",
  "credentials": {
    "apiKey": "YOUR_API_KEY"
  }
}),
});

Execute

bash
chainabit connectors exec <instance-id> list_workspaces --input '{}'
bash
curl -X POST "$BASE_URL/connectors/instances/<instance-id>/tools/tool_list_workspaces/execute" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {}
}'
javascript
const response = await fetch(
  `${BASE_URL}/connectors/instances/<instance-id>/tools/tool_list_workspaces/execute`,
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
  "input": {}
}),
  },
);

Security Notes

  • Keep tokens, API keys, and connection strings in the encrypted credentials vault.
  • Do not allow arbitrary server URLs for remote MCP connectors.
  • Provide a Postman API key in the X-Api-Key credential slot.

Troubleshooting

  • If the health check fails, verify the token scope or credential payload and try again.
  • If the tool list is empty, re-run sync-tools after storing the latest credentials.

Back to the catalog

Built with purpose.