Postman
Product
PricingEnterprise
Resources and Support
API Network
Contact SalesSign InSign Up for Free
Postman Docs
  • Introduction
    • Overview
    • Resources
    • Feedback
    • Troubleshooting
  • Get started
    • Welcome
    • Postman first steps
      • Overview
      • Download
      • Send a request
      • Write a test
      • Sign in
      • Create a collection
      • Explore the Postman API Network
      • Next steps
    • Postman basics
      • Overview
      • The Postman interface
      • Postman elements
      • The Postman Agent
      • Postbot
      • Postman VS Code extension
      • Collaboration basics
      • Syncing
      • Lightweight API Client
      • Scratch Pad
    • Your Postman account
      • Overview
      • Sign up
      • Settings
    • Install and configure
      • Overview
      • Installation and updates
      • Settings
      • Customize your profile
      • Proxy server configuration
    • Import and export data
      • Overview
      • Data import methods
      • SoapUI import
      • Hoppscotch import
      • Insomnia import
      • Thunder Client import
      • Git import
      • New Relic import
      • cURL command import
      • Swagger API import
      • Data export
  • Send requests
    • Overview
    • Create requests
      • Overview
      • Request basics
      • Parameters and body data
      • Request headers
      • Test data storage
      • Customize request settings
      • Group requests in collections
      • Generate client code
    • Authentication and authorization
      • Overview
      • Add certificates
      • Request authorization
      • Public API authorization
      • Authorization types
      • Digest
      • OAuth 1.0
      • OAuth 2.0
      • Hawk
      • AWS Signature
      • NTLM
      • Akamai Edgegrid
      • ASAP (Atlassian)
    • Response data and cookies
      • Overview
      • API response structure
      • Visualize request responses
      • Create request response examples
      • Create and send cookies
      • Debug requests
    • Variables and environments
      • Overview
      • Store values in variables
      • Create and use environments
      • Set environment variables
      • Manage team environments
      • Pinned environments
    • Postman Vault
      • Overview
      • Manage vault key
      • Vault secrets
      • Vault secrets for public APIs
      • Postman Vault integrations
        • Integrations overview
        • 1Password
        • AWS Secrets Manager
        • Azure Key Vault
        • HashiCorp Vault
        • Manage integrations
      • Troubleshoot vault secrets
    • Capture API traffic
      • Overview
      • Capture traffic with Postman proxy
      • Capture HTTP requests
      • Capture HTTPS traffic
      • Capture traffic with Postman Interceptor
      • Sync cookies
    • GraphQL
      • Overview
      • Create GraphQL requests
      • The GraphQL interface
      • Other GraphQL requests
    • gRPC
      • Overview
      • The gRPC interface
      • Invoke a gRPC request
      • Manage gRPC service definitions
      • Test gRPC requests
      • Write tests for gRPC requests
      • Postman Sandbox API
      • gRPC mock servers
      • gRPC request-response examples
      • gRPC protobuf types
    • WebSocket
      • Overview
      • Create a WebSocket request
      • Create a Socket.IO request
      • Work with WebSocket messages
      • Listen to Socket.IO events
      • Use variables in WebSocket requests
      • Add details to a WebSocket request
      • Save WebSocket requests
      • Document WebSocket requests
      • Troubleshoot WebSocket requests
    • MQTT
      • Overview
      • Manage MQTT requests
      • Create an MQTT request
    • SOAP
      • Send SOAP requests
  • Tests and scripts
    • Overview
    • Write scripts
      • Overview
      • Write pre-request scripts
      • Write tests
      • Use packages in scripts
        • Overview
        • Reuse internal scripts
        • Use packages from external registries
      • Script examples
      • Dynamic variables
      • Postman JavaScript reference
    • Test APIs
      • Overview
      • Integration testing
      • End-to-end testing
      • Regression testing
      • Performance testing
    • Run and automate tests
      • Overview
      • Run tests manually
      • Run tests on a schedule
      • Run tests in CI/CD pipelines
      • Run tests with monitors
  • Postman Collections
    • Overview
    • Create and manage collections
      • Overview
      • Create collections
      • Add requests to collections
      • Manage and organize collections
      • Collaborate with collections
      • View collection activity and elements
    • Run collections
      • Overview
      • Collection Runner
      • Automate collection runs
      • View scheduled collection runs
      • Schedule collection runs with monitors
      • Trigger collection runs
      • Customize collection run order
      • Run a collection with imported data
    • Test API performance
      • Overview
      • Run a performance test
      • View performance test metrics
      • Debug performance test errors
      • Inject data into virtual users
    • Postman CLI
      • Overview
      • Install
      • Command options
      • Run a collection
      • Built-in reporters
    • Newman CLI
      • Run and test collections with Newman CLI
      • Install and run Newman
      • Newman command reference
      • Upload files with Newman
      • Use Newman built-in reporters
      • Use Newman external and custom reporters
      • Newman with Docker
      • CI with Newman
      • Travis CI with Newman
      • Jenkins with Newman
    • Monitor collections
      • Overview
      • Set up a monitor
      • View monitor results
      • Manage monitors
      • Run monitors using static IPs
      • Troubleshoot monitors
      • Monitoring FAQ
  • Collaborate in Postman
    • Overview
    • Collaboration concepts
    • Collaboration features
    • Define roles
    • Use teams
    • Manage user groups
    • Manage access
    • Share your work
    • Comment on APIs
    • Document APIs
      • Overview
      • Document a collection
      • Add API documentation
      • Write documentation
      • Publish documentation
      • View documentation
      • Host API documentation
      • Set up authentication for public APIs
      • Run in Postman
        • Overview
        • Create Run in Postman buttons
        • Code with Run in Postman
    • Private API Network
      • Overview
      • Explore your Private API Network
      • Organize your Private API Network
      • Manage your Private API Network
      • Request additions to your Private API Network
      • Automate publishing to your Private API Network
    • Version control
      • Overview
      • Fork Postman elements
      • Create pull requests
      • Review pull requests
      • Watch pull requests
    • Public elements
    • Workspaces
      • Overview
      • Create workspaces
      • Use workspaces
      • Workspace updates
      • View team activity
      • Manage workspaces
      • Partner Workspaces
        • Overview
        • Set up a Partner Workspace
        • Collaborate as a partner
        • Multi-partner Workspaces
        • Manage Partner Workspaces
      • Public workspaces
  • Design and build APIs
    • Overview
    • Design APIs with collections
      • Overview
      • Turn on types in collections
      • Add properties to parameters and headers
      • Add properties to body data
      • View properties and documentation
      • Generate API specifications
    • Design APIs with specifications
      • Overview
      • Create a specification
      • Import a specification
      • Edit a specification
      • View live documentation
      • Generate collections
    • Develop APIs with the API Builder
      • Overview
      • Create an API
      • Import an API
      • API version control
        • Overview
        • Cloud-hosted Git repository
        • On-premises Git repository
        • Manage multiple APIs
        • Manage Git changes in Postman
        • Publish an API version
      • Develop an API
        • Overview
        • Manage API definitions
        • Add elements to an API
        • Generate server-side code
        • Validate an API
      • Test an API
      • Deploy an API
        • Overview
        • Amazon API Gateway
        • Apigee
        • Azure API Management
      • Observe an API
        • Overview
        • New Relic
        • Datadog
      • Manage and share APIs
    • Mock an API
      • Overview
      • Set up mock servers
      • Create dynamic mock responses
      • Mock using saved examples
      • Mock using the Postman API
      • Matching algorithm
  • Administer Postman
    • Overview
    • Onboarding checklist
    • Migrate data between teams
    • Team management
      • Overview
      • Create teams
      • Manage team members
      • Manage team resources
      • Manage product access
      • Configure team settings
      • Manage API keys
      • Secret Scanner
      • BYOK Encryption
      • Audit logs
    • Billing
      • Overview
      • Manage billing
      • Purchase Postman
      • About resource usage
      • About Postman Flows usage
    • Integrations
      • Overview
      • Custom webhooks
      • Installed apps
      • CI integrations
      • Postman integrations
        • All integrations
        • APIMatic
        • Apigee
        • AWS API Gateway
        • Azure API Management
        • Azure DevOps
        • Azure Pipelines
        • BigPanda
        • Bitbucket
        • Bitbucket Pipelines
        • CircleCI
        • Coralogix
        • Datadog
        • Dropbox
        • GitHub
        • GitHub Actions
        • GitLab
        • GitLab CI/CD
        • Jenkins
        • Keen
        • Microsoft Power Automate
        • Microsoft Teams
          • Overview
          • Postman app for Teams
          • Send notifications to Teams
        • New Relic
        • OpenAPI
        • Opsgenie
        • PagerDuty
        • Slack
          • Overview
          • Postman app for Slack
          • Get Slack notifications
          • Post monitoring results
          • Post team activity
        • Splunk
        • Splunk On-Call
        • Statuspage
        • Travis CI
    • Postman Enterprise
      • Overview
      • Enterprise plans
      • Enterprise onboarding
      • Enterprise deployment
      • Postman EU Data Residency
      • API Governance
        • Overview
        • API rules
          • Overview
          • OpenAPI 3 rules
          • OpenAPI 2 rules
        • API request warnings
          • Overview
          • Security warnings
        • Configurable rules
          • Overview
          • API Governance rules
          • API Security rules
          • Custom governance functions
          • Spectral
      • Reports
        • Overview
        • Overview report
        • Members overview report
        • Content activity report
        • API Security report
        • API Governance report
        • Public workspace metrics report
        • Billing overview report
        • Secret Scanner report
    • Single Sign-On (SSO)
      • Intro to SSO
      • Configure SSO for a team
      • Sign in to an SSO team
      • SSO and SCIM FAQs
      • Microsoft AD FS
      • Microsoft Entra ID
      • Custom SAML
      • Duo
      • Google Workspace
      • Okta
      • OneLogin
      • Ping Identity
    • SCIM provisioning
      • SCIM provisioning overview
      • Configure SCIM with Okta
      • Configure SCIM with Microsoft Entra ID
      • Configure SCIM with OneLogin
    • Domain verification and capture
      • Overview
      • Add and verify a domain
      • Enable domain capture
      • Domain capture support and FAQs
    • Admin FAQs
  • Postman Flows
    • Overview
    • Get started with Flows
      • Overview
      • Get familiar with the Flows editor
      • Explore the Flows Catalog
      • Build your first flow module
    • Build flows
      • Overview
      • Create blocks
      • Create connections
      • Create a request
      • Loops
      • Visualize data
      • Organize flows
      • Version flows with snapshots
      • Copy flows with clones
      • Demo flows with slides
      • Deploy flows as actions
      • Check actions health and activity
      • Assign input values
      • Work with date and time
      • Find and filter data
      • Troubleshoot flows
      • Share and embed flows
      • Blocks
        • Overview
        • Flow Module
        • HTTP Request
        • AI Request
        • Create with AI
        • Delay
        • Start
        • Output
        • Condition
        • If
        • Validate
        • Evaluate
        • Collect
        • For
        • Repeat
        • Display
        • Log
        • String
        • Bool
        • Number
        • Null
        • Select
        • Now
        • Date
        • Date and time
        • List
        • Record
        • Create variable
        • Get variable
        • Template
        • Request
        • Response
    • Flows Query Language
      • Overview
      • Get basic values
      • Select conditional data
      • Return structured data
      • Manipulate data
      • Function reference
    • Typescript in flows
      • Use TypeScript in flows
    • Learn Flows with tutorials
      • Overview
      • Beginner tutorials
        • Overview
        • Send a request
        • Calculate years since milestone
        • Create a count-based loop
        • Create a list-based loop
      • Advanced tutorials
        • Overview
        • Exchange data between systems
        • Create a dashboard in Flows
        • Automate repetitive tasks
        • Run requests in sequence
      • Video tutorials
        • Overview
        • Create a Postman Flow
        • Create with AI in flows
        • Flows scenarios and test data
        • Flows snapshots and modules
        • Flows actions
    • Build flows with AI
      • Postbot in Flows
  • Postman AI Agent Builder
    • Overview
    • Add AI requests to your collections
      • Overview
      • Create AI requests
      • Use requests to interact with AI models
      • Manage request settings
    • Add AI request blocks to your flows
      • Overview
      • Create AI request blocks
      • Use blocks to interact with AI models
    • Add MCP requests to your collections