Authentication

Suggest Edits

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

Your API Key can be found within Pinpoint by navigating to Settings -> Integrations.

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 let us know and we can issue you with a new one.

Example

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

Updated almost 3 years ago