Documentation menu

Purpl Documentation

Overview

Base URL and shared contracts for the public HTTP API officially supported by Purpl.

Base URL

Base URL
https://api.purpl.sh

Authentication

Each endpoint page shows whether authentication is required and which scope it uses. Keep application API credentials only on trusted servers.

OpenAPI contract

The API Reference reads the deployed OpenAPI contract to render parameters, request bodies, responses, and cURL examples.

OpenAPI
https://api.purpl.sh/openapi.json

Choose a resource