The Pinpoint Developer Hub

Welcome to the Pinpoint developer hub. You'll find comprehensive guides and documentation to help you start working with Pinpoint as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    API Reference



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.

Base URL

All requests to the API should be made to a URL of the format:

your-subdomain is the same subdomain you see when you log in to Pinpoint itself (

Each request URL is then suffixed with the respective resource you are dealing with. e.g.

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.

Updated 2 months ago

What's Next

Next learn about how to authenticate with our API



Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.