Explore your Postman Private API Network

Your Private API Network is available on Postman Enterprise plans. Viewing APIs on your Private API Network requires the API Builder add-on.

As a member of your team, you can search for and discover workspaces and collections on your team's Private API Network. Open an element to view details about it and take additional actions, such as share a workspace or fork a collection.

If your team has the API Builder add-on, team members can also search for and discover APIs on your team's Private API Network.

Explore your Private API Network

You can use your team's Private API Network to learn about workspaces, collections, and APIs shared within your team. In the left sidebar, you can browse a directory of elements shared within your team.

There are several ways to access your team's Private API Network:

  • Select Home from the Postman header, then select Private API Network in your team information on the left sidebar.
  • Select API Network from the Postman header, then select View internal APIs.
  • Select Search Postman in the header, change the scope to Private API Network, then enter your search terms.

Search, filter, and sort

There are several ways to search, filter, and sort elements and folders in your Private API Network. You can select Home icon Home to sort popular elements. You can select Search Postman in the header to enter search terms and filter the results. You can also select a folder to sort elements in it.

You can select Home icon Home in the left sidebar to discover popular and new elements. On the right, you can sort popular elements by Week or Month. You can also review elements that were recently added. Select Show more to review more elements in either category.

Private API Network discover elements

API Network Managers who are setting up your Private API Network might see a list of suggested elements on the right. Postman suggests adding these elements because they're popular within your team, meaning your team might benefit from having them in your Private API Network. To add a suggested element, select Add.

Private API Network suggested elements

Search for elements

You can search and filter elements. Select Search Postman in the header, change the scope to Private API Network, then enter your search terms. If you're in your team's Private API Network, the scope will be automatically set to Private API Network. You can also specify the element you'd like to search for: Workspaces, Collections, Requests, APIs, or Folders. You can select Enter or select an element's name in the search results to open it. To learn more about searching in Postman, see Search Postman.

Search your Private API Network

Then you can filter elements with the following options:

  • To filter by element type, select Element type, then select Workspaces, Collections, APIs, Request, or Folder.
  • To filter by tags added to collections, APIs, or workspaces, select Search tags, then select tags. You can't filter by tags on Request or Folder element types. Learn more about adding tags to collections, APIs, and workspaces.
  • To filter by an element's location in a folder in the left sidebar, select Location, then select the folder or subfolder. When you filter by a folder, your search results return elements in the folder and its subfolders. To filter by all elements, including elements not organized in folders, don't filter by an element's location.
Filter and search your Private API Network

Sort elements in a folder

You can sort elements in a folder and its subfolders. To sort elements, select a folder or subfolder in the left sidebar, then select the Sort by dropdown list. The options are:

  • Recently added - Sort elements by the date they were added.
  • A to Z - Sort elements alphabetically.
  • Trending this week - Sort elements by your team's usage this week.
  • Trending this month - Sort elements by your team's usage this month.
Sort elements in a folder

Review details about elements

Select a workspace, collection, or API from the left sidebar to review information about it. On the right, you can view its description and the editors who have worked on it. You can view the following details:

  • For workspaces, you can view all of the collections and APIs inside them.

  • For collections, you can view available documentation. In the documentation, you can select Try Request next to a request or Try Example next to an example to open it in a new tab. To learn more about trying an example, see Try an example.

  • For APIs, you can view API definitions and associated API documentation. You can also view collections added to the API.

    If you published an API with an API definition that has syntax errors, your API documentation might not display as expected. To learn more about viewing syntax errors, see Viewing syntax errors in your API definition.

You can also open the element in its workspace. Select an element from the left sidebar, and then select either View in Workspace or Open Workspace in the upper-right corner.

Share folders and elements

You can share links to folders and individual elements with other team members. Select Options icon Options next to a folder or element, then select Copy link. This copies the link to your clipboard. You can then share the link with team members.

You can also select a folder or element in the sidebar. Then select Link icon Copy link in the upper-right corner.

Watch and fork elements

You can watch workspaces, collections, and APIs from your Private API Network. You can also fork collections from your Private API Network.

To watch a workspace, collection, or API and get notified about any changes, select an element in the left sidebar, then select View icon Watch in the upper-right corner. Learn more about watch notification for workspaces, collections, and APIs.

To fork a collection, select a collection in the left sidebar, then select Fork icon Fork in the upper-right corner. Learn more about forking collections.

Last modified: 2024/09/27