---
updatedAt: 2026-02-04T16:12:26.000Z
agentTools:
  projectIndex: https://developers.pinpointhq.com/llms.txt
---

# 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](https://jsonapi.org/).

> 👍 If you require a more conventional JSON object as the return payload you can add `.json` to the endpoint

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](https://developers.pinpointhq.com/docs/3rd-party-vendors-integrations) we ask for

If you plan to build an integration with an assessment or background checking service, please take a moment to consider building using our [Integration Plugins Framework ](https://developers.pinpointhq.com/docs/overview) (quickest to build, best UX for our mutual customers)

## 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](https://www.postman.com/) as an easy way to start making requests.