Load OpenAPI Schema

In order to explore our API locally, there are a number of API platforms available that let you interact with the OpenAPI schema (downloadable here). In this example we'll show how to import the schema to Postman and make a request.

Import to Postman

Once you have Postman downloaded and are signed in, you should be able to create a new Workspace and click the import button in the top right of the side pane. Here, you can select the downloaded PivotCX API.yaml schema file.

Screenshot of Postman highlighting the import collection button

You should be able to expand the new API collection you've imported. Here, you can explore the available endpoints. Notably, the majority of endpoints of interest are going to be under /v1/users/{parent_lookup_user}/teams/{parent_lookup_team}. (This API structure guarantees a level of security where users are not able to access content they're not intending to see).

Preparing a Request

All the API endpoints are free to explore, but to use this API collection you've imported, you need a PivotCX team and account which we will configure when you request access to our API.

When viewing a particular request, to submit it successfully, you'll need to remove the default params and supply your team and user ids.

Screenshot of Postman highlighting the bulk edit params button

From this screen, you can select Bulk Edit in the top right of the params list, and delete all the param values (ctrl+A to select all text). Once those are deleted, scroll down to see the two path params, the team and user id. You can substitute your provided team and user ids in the path variables section to form a complete API request.

Making a Request

Now that you have your request configured, you'll need to authenticate the request. Head to the Authorization tab and in the Type dropdown select Basic Auth, then input your PivotCX username and password.

Screenshot of Postman highlighting the authorization type dropdown

After that, everything is ready! Click the send button to submit the request. You should receive a JSON response in the response panel.

You've successfully made your first request! Follow these instructions for other endpoints. For POST requests, you can click the Body tab to provide data in the post payload.