- Installation and updates
- Sending your first request
- Navigating Postman
- New button
- Creating the first collection
- Postman account
- Keyboard Shortcuts
- Troubleshooting In-app Issues
- Authorizing requests
- Working with Tabs
- Visualize API responses
- Validating Requests Against Schema
- Generate code snippets
- Using GraphQL
- Making SOAP requests
- Capturing HTTP requests
- Debugging and logs
- Troubleshooting API requests
- Intro to collections
- Creating collections
- Sharing collections
- Commenting on collections
- Managing collections
- Version Control for Collections
- Using Markdown for descriptions
- Data formats
- Working with OpenAPI
- Collaborating in Postman
- Roles and permissions
- Managing your team
- Requesting access
- Team Settings
- Audit logs
- Intro to scripts
- Pre-request scripts
- Test scripts
- Test examples
- Branching and looping
- Postman Sandbox API reference
- Intro to collection runs
- Starting a collection run
- Using environments in collection runs
- Building workflows
- Running multiple iterations
- Sharing collection runs
- Working with data files
- Debugging a collection run
- Command line integration with Newman
- Integration with Jenkins
- Integration with Travis CI
- Newman with Docker
- Documenting your API
- Authoring your documentation
- Publishing your docs
- Viewing documentation
- Custom documentation domains
- Intro to mock servers
- Setting up a mock server
- Mocking with examples
- Mocking with the Postman API
- Matching algorithm
- Intro to Monitoring
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- FAQs for monitors
- Intro to Workspaces
- Creating Workspaces
- Using Workspaces
- Managing Workspaces
- Viewing changelogs and restoring collections
- The API Workflow
- Managing and Sharing APIs
- Versioning APIs
- Viewing and analyzing APIs
- Validating Elements Against Schema
- Customizing Postman
- Find and Replace
- Purchasing Postman
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Configuring Microsoft AD FS with Postman SSO
- Setting a custom SAML in Azure AD
- Setting up custom SAML in Duo
- Setting up custom SAML in GSuite
- Setting up custom SAML in Okta
- Setting up custom SAML in Onelogin
- Setting up custom SAML in Ping Identity
- Intro to Integrations
- Custom Webhooks
- Microsoft Flow
- Microsoft Teams
- Publishing API documentation
Managing and Sharing APIs
When you define your APIs in Postman using the API Builder, each API is associated with a workspace. You can share access to your APIs, discuss them in comments, and view schema activity.
You can share an API via its workspace either in the Postman app or the web dashboard. By sharing your workspace with collaborators, you can provide access to the API via designated roles with specific permissions, including Viewer and Editor.
The Viewer role is only available on certain Postman plans.
If you share an API to a workspace, members of the workspace will have access to any shared elements linked to the API (for example documentation, test suites, monitors). Workspace members can view elements linked to an API but can only edit if an element is also shared within the workspace. If you delete the API or remove it from the workspace, members will still have access to those shared elements unless you remove them also.
In the Postman app, select an API in the sidebar and click (...) to open the menu, choosing Share API.
Select a workspace and click Share and Continue.
Configure access levels for collaborators in your workspace and click Save Roles.
You can also share APIs in the web dashboard by navigating to APIs and clicking Share next to the API.
You can discuss your APIs with collaborators in the Postman app or web dashboard, keeping the conversation in context and available to other stakeholders. Anyone with access can comment, and comments will be visible in both the app and the dashboard.
To leave a comment on an API using the Postman app, open APIs in the left sidebar and select the API you want to comment on. Click Comments at the top-right, enter your comment, and Add comment to publish it.
To comment on an API in the web dashboard, navigate to APIs, select the API you want to comment on, and click Comments at the top-right of the page. Enter your comment, and Add comment to publish it.
You can use Markdown in your comments—check out the Markdown Cheatsheet on Github for tips on formatting.
If you want to call the attention of a collaborator in comment, you can tag them by typing
@ followed by their name—choose the person from the auto-suggested list. When you tag a member in your comment, Postman will send them a notification.
To edit or delete one of your comments, navigate to the comment section and hover over the comment you wish to manage. Click the pen icon to edit the comment, or the bin icon to delete.
With Admin permissions you can delete comments made by any contributor, but you cannot update or modify comments.
You can view a changelog of your API schemas in APIs > Design. Click View changelog.
You will see a list of events on the schema and can click to expand each entry for more detail.
You can use the Restore link to revert the schema to a previous state.
For more info on working with the API Builder in Postman, check out the following resources: