For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Postman
PricingEnterprise
Contact SalesSign InSign Up for Free
HomeDocs
HomeDocs
      • Overview
        • Overview
        • Add types to parameters and headers
        • Add types to body data
        • View types and documentation
        • Generate API specifications
      • Sync collections and specifications reference
      • Migrate from API Builder to Spec Hub
      • Develop APIs with the API Builder
      • Simulate real-world conditions
Postman API Platform

Product

  • Postman Overview
  • Enterprise
  • Spec Hub
  • Flows
  • Agent Mode
  • API Catalog
  • Fern
  • Postman CLI
  • Integrations
  • Workspaces
  • Plans and pricing

API Network

  • App Security
  • Artificial Intelligence
  • Communication
  • Data Analytics
  • Database
  • Developer Productivity
  • DevOps
  • Ecommerce
  • eSignature
  • Financial Services
  • Payments
  • Travel

Resources

  • Postman Docs
  • Academy
  • Community
  • Templates
  • Intergalactic
  • Videos
  • MCP Servers

Legal and Security

  • Legal Terms Hub
  • Terms of Service
  • Postman Product Terms
  • Security
  • Website Terms of Use

Company

  • About
  • Careers and culture
  • Contact us
  • Partner program
  • Customer stories
  • Student programs
  • Press and media
Twitter iconLinkedIn iconGithub iconYouTube iconInstagram iconDiscord icon
Download Postman
Privacy Policy

© 2026 Postman, Inc.

On this page
  • View types for parameters, headers, and body data
  • View documentation for a collection with types
Design and build APIsDesign APIs with collections

View types and documentation for an API collection

||View as Markdown|
Was this page helpful?
Previous

Add types to body data with an API collection

Next

Generate an API specification from your collection

Built with

Anyone with access to a collection with types can view them for parameters, headers, and body data. They can also view types in the collection’s documentation.

Knowing more details about a requests in a collection, such as a parameter’s type or if a header is required, can help others better understand your API. It can also help consumers send valid API requests, so they get successful responses instead of errors.

View types for parameters, headers, and body data

You can view types for parameters, headers, and body data in a collection. If you enter a value that isn’t valid, Postman flags it with an orange underline. Hover over the text or variable with the orange underline to view a tooltip about the issue. This enables you to fix any issues before you send the request.

Open a request and click the Params or Headers tab. Click an empty value for a query or path parameter or a header to view more details. For example, more details may include the accepted values and default value. A red asterisk next to the key indicates that it’s required. The component type, like string, also displays next to the key.

View component types

Enter a value for the parameter or header, or select a value from the list if enumerations are defined.

Show valid values

You can also open a request and click the Body tab, or open a saved example and go to the response body. Click Manage icon Schema to show the schema pane. Hover over a key or value in the body data to view more details, such as the description, or view any issues with the body data.

When you fork a collection with types, you fork both the collection and types added to request components, such as parameters. Note that changes to types can’t be pulled into a forked collection, merged into the parent collection, or pulled or merged during the pull request process.

View documentation for a collection with types

To view documentation for a collection, click the collection’s Overview tab. Then, click View complete documentation.

The documentation for a collection includes any types added to parameters and headers, such as format, allowed values (enumerations), and if the component is required.

View documentation for a collection with types

If a request has body data, you can view it in raw (JSON) format or as a schema. When viewing the schema, click Show properties to show the body data with its types.