Overview
Postman is the dominant API-development platform – collections of HTTP requests, environments (variables), monitors (scheduled runs), mock servers, and team workspaces. The Automize Postman connector covers workspace + collection + environment listing, monitor reads, and monitor execution.
- Regions: Postman is global – api.getpostman.com.
- Plans: Free, Basic, Professional, Enterprise – all expose the API. Monitor runs + mocks have plan-based quotas.
Setting up the connection
Auth type: API Key.
- Sign in to postman.com → Settings → API keys → Generate API Key.
- Copy the key (starts with PMAK-).
- In Automize, open Settings → Connectors → Postman → Add connection. Paste key (sent as X-Api-Key header).
Find your credentials at https://postman.com/settings/me/api-keys.
Rate limits
Free: 1,000 requests/hour. Paid plans higher. Connector retries 429 with backoff.
Data model
Postman primitives:
Workspace ─┬─ Collections ─── Folders ─── Requests
├─ Environments (named variable bundles)
├─ Monitors (scheduled collection runs)
├─ Mocks (mock servers)
└─ APIs (versioned API definitions)Available operations
8 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Get Collection | General | Get collection details |
| Get Environment | General | Get environment details |
| List APIs | General | List all APIs |
| List Collections | General | List all collections |
| List Environments | General | List all environments |
| List Monitors | General | List all monitors |
| List Workspaces | General | List all workspaces |
| Run Monitor | General | Trigger a monitor run |
Operations
Get Collection
Get collection details
| Parameter | Required | Type | Description |
|---|---|---|---|
Collection Id collection_id | Yes | text |
Tips
- Returns full collection definition (Postman Collection Format v2.1).
- Heavy payload – big collections can be MB.
Get Environment
Get environment details
| Parameter | Required | Type | Description |
|---|---|---|---|
Environment Id environment_id | Yes | text |
Tips
- Returns environment variables (key-value pairs + secret flags).
List APIs
List all APIs
No input parameters.
Tips
- Defined APIs (schemas, versions). Used with Postman API Network features.
List Collections
List all collections
No input parameters.
Tips
- Workspace-scoped. Filter via workspace param.
List Environments
List all environments
No input parameters.
Tips
- Environments hold variables used by collections.
List Monitors
List all monitors
No input parameters.
Tips
- Scheduled monitors. Returns next run time, last run status.
List Workspaces
List all workspaces
No input parameters.
Tips
- Returns workspaces visible to your key. Personal + team workspaces.
Run Monitor
Trigger a monitor run
| Parameter | Required | Type | Description |
|---|---|---|---|
Monitor Id monitor_id | Yes | text |
Tips
- monitor_id. Triggers an ad-hoc run. Returns run_id + immediate status (Postman runs async).
FAQ
- Why do collection downloads include <dynamic> placeholders?
- Postman's variable substitution. Resolve at runtime by overlaying with an environment via the API client (or Newman CLI).
- Newman vs Run Monitor?
- Newman = local CLI runner. Run Monitor = Postman-cloud runs against your monitor schedule. Use Newman for local CI; Run Monitor for cloud-hosted scheduled tests.
- Postman Visualizer / Mocks – covered?
- Not in this connector. Use the Postman UI/CLI for visualisation + mock-server config.