Authentication

Overview

The Pinpoint API uses an API key to authenticate requests. The API key must be passed with every request as a X-API-KEY header.

API requests without authentication will fail and return a HTTP 401 response.

Generating your API key

👍Read this article to learn how to get your API key.

Go to your Pinpoint account (if you are a vendor and need a sandbox, go to 3rd Party Vendors / Integrations page):

Click Settings in the left sidebar
Select API & Webhooks
Make sure the Pinpoint API toggle is switched on (you'll see it in the top-right corner)
Go to API Keys tab and follow the instructions from the link above

Be sure to keep your API key secure. Do not share your secret API key in publicly accessible areas such as GitHub, client-side code, and so forth. If you think at any point your API key has been compromised, please remove from it the API & Webhooks ASAP and let us know.

Example

curl -v -H "x-api-key: your-api-key" https://your-subdomain.pinpointhq.com/api/v1/jobs