Prepare your public workspace and collections for the Postman API Network

Your public workspace is a landing page for your public APIs. It’s where API consumers find your public APIs, learn about them, and can fork your public collections to their own workspace. In your public workspace, you’ll create a public API reference collection and overview collection. When you publish your public APIs, you can invite your API consumers to fork these collections, and get them to their first 200 OK response fast.

Create your public workspace

Create an internal workspace to serve as your public workspace. You’ll make it public when you’re ready to publish your public APIs to the Postman API Network. When you create it, choose whether to share access with everyone in your team or only you and invited people.

To learn more, see Create a workspace in Postman.

Invite your team and describe your workspace

Invite the team members who’ll help you prepare your public APIs. Then, add a summary and description to your workspace. You can continue to invite team members and edit your workspace details as your workspace, its collections, and your public APIs evolve.

To learn more, see Share workspaces and Edit workspace details.

Create your public API reference collection

An API reference collection is a comprehensive list of your public API’s endpoints and their HTTP methods, which define your API’s operations. It’s often based on an API specification, such as an OpenAPI definition.

Postman recommends you import your OpenAPI definition into your public workspace. Postman turns your definition into a Postman Collection. If you don’t have an OpenAPI definition, create a collection in your public workspace and add a request for each of your endpoints.

To learn more, see Import an API specification and Create a new collection.

Create your public overview collection

An overview collection complements your API reference collection. It’s a starting point for your API consumers. Use an overview collection to summarize your public APIs and get your API consumers to their first 200 OK response in the fewest steps possible. You can also showcase your public APIs with common use cases and popular workflows.

To create your overview collection, create a collection in your public workspace. To learn more, see Create a new collection.

Curate your public collections

Once you’ve created your API reference and overview collections, name and describe them, add requests and examples, document your requests, and organize them with folders. You can continue to curate both collections as your public APIs evolve.

To learn more, see Curate your public collections for the Postman API Network.