Introduction

Specification

The Pinpoint API is organised around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, and verbs.

The API follows the JSON API spec.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

3rd Parties / Integration Providers

If you are looking to build an integration for use by Pinpoint customers, please take time to read the requirements we ask for

Base URL

All requests to the API should be made to a URL of the format:
https://{your-subdomain}.pinpointhq.com/api/v1

your-subdomain is the same subdomain you see when you log in to Pinpoint itself (your-subdomain.pinpointhq.com).

Each request URL is then suffixed with the respective resource you are dealing with. e.g. https://acme.pinpointhq.com/api/v1/jobs.

Getting started

If you are looking for a quick way to get started with the API we recommend Postman as an easy way to start making requests.