Download Postman Collection

Installing Postman

Download Postman: Visit the Postman website and download the appropriate version for your operating system.
Install Postman: Follow the installation instructions for your operating system to install Postman.

Downloading the Collection and Environment

Download the archive: Click here to download the Postman collection and its matching production environment, zipped together. Check back here for a newer one periodically.
Unzip the archive: Extract it to a location on your computer. You’ll get two files: PPS-Public-APIs.postman_collection.json (the requests) and pps-public-apis-prod.postman_environment.json (the variables they use).

Read the descriptions. Every folder and request in this Postman collection carries a “docs” / description tab in Postman with real, detailed guidance — setup notes, gotchas, field explanations, links to the right page in the API reference. If something isn’t behaving the way you expect, check the description before you assume it’s broken. It is very easy to miss this tab, and it holds the answer more often than not.

Importing into Postman

Open Postman: Launch the Postman application.
Import both files at once:
- Click Import in the top-left corner of the Postman interface.
- Select Upload Files.
- Navigate to where you extracted the archive and select both .json files together — Postman imports the collection and the environment in one step.
Select the environment: In the top-right environment picker, choose pps-public-apis-prod so the collection’s requests resolve {{pps-public-host}} and the other variables it uses.

Setting your credentials

The environment ships with empty values for anything you need to supply yourself — nothing in it is pre-filled with a real credential.

Get your credentials from PitchPoint: a username and password for ordinary API calls, and (if you’re integrating webhooks) a separate coordinator username and password for the webhook-management endpoints.
Set them in Postman:
- Open the pps-public-apis-prod environment (the pencil icon next to the environment picker).
- Set user-username and user-password to your own credentials.
- If you’re using the Webhooks folder, also set coordinator-username and coordinator-password.
Run the Sign In request first: the Auth folder’s Sign In request (under User, and separately under Coordinator) exchanges your username and password for an access token, and its script stores that token into the environment automatically — the rest of the collection reads it from there, so you don’t paste a token in by hand.

The collection also covers ordering, sessions and workflows, findings, and webhooks, with a couple of end-to-end scenario folders that walk a full order through to a reconfirm. If you’re new to a particular API, pair the request you’re looking at with its writeup in the API reference — the request names in this collection match the operation names used there.