Testing APIs with Postman

Learn how to use our Postman collection to test Customer Hub APIs.

What is Postman?

Postman is an app for easy RESTful API exploration. You can save multiple sets of credentials (as environments) so you can quickly and easily test API calls in sandbox and production.

Step 1: Get the Postman collection

Click Run in Postman button below to install/open Postman and import collection.

Run in Postman

Imported Collection

Step 2: Create your Postman environment

Our collection makes use of Postman's environment variables to easily manage your API credentials.

Find the EYE icon in right top of the screen and click ADD link.

Environment Popup

Setup Environment Variables (provided by us when you enter into the Customer Hub integration program):

  • apiHost - Customer Hub api service host
  • clientId - Your application client id, to app in Customer Hub api server
  • clientSecret - Your application secret to access Customer Hub api server
  • locationId - Customer Hub Location identifier

Environment Variables

Step 3: Make a call

Let's make a call to the Ticket endpoint using your sandbox environment.

Environment Variables

results matching ""

    No results matching ""