Developer docs menu

PACE Partner API

Overview

Quickstart, and how to build with Claude Code or Codex.

Connect your hospital, pharma or partner system to PACE. The Partner API is a versioned REST API under /api/v1/, secured with OAuth 2.0 client credentials and described by a published OpenAPI 3 specification.

What you can do today

  • Exchange your client credentials for an access token.
  • Confirm which organisation, environment and permissions your credentials belong to.
  • Build and test against a sandbox organisation that holds realistic demo data and no real patients.

Programme data, events and referrals arrive in the next release. See Roadmap.

Quickstart

1. Get your credentials

PACE creates an API client for your organisation and sends you a client_id and a client_secret over a secure channel. Start with a sandbox client.

2. Request an access token

Shell
curl -s -X POST https://mypacehub.com/api/v1/oauth/token/ \
  -u "$PACE_CLIENT_ID:$PACE_CLIENT_SECRET" \
  -d grant_type=client_credentials
JSON
{
  "access_token": "pace_at_...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": ""
}

3. Make your first call

Shell
curl -s https://mypacehub.com/api/v1/me/ \
  -H "Authorization: Bearer $PACE_ACCESS_TOKEN"
JSON
{
  "api_version": "1",
  "client_id": "pc_3f9a...",
  "name": "Sandbox CRM",
  "audience": "pharma",
  "organization": { "name": "Demo Pharma", "slug": "demo-pharma" },
  "environment": "sandbox",
  "scopes": [],
  "token_expires_at": "2026-10-16T19:00:00Z",
  "rate_limit_per_minute": 120
}

If you see your organisation and "environment": "sandbox", your integration is connected.

Build with Claude Code or Codex

Every page of these docs is available as plain Markdown, so a coding assistant can read the exact contract instead of guessing it.

  • One file with everything: /llms-full.txt holds every guide and the full API reference.
  • Index: /llms.txt lists every page with a link to its Markdown.
  • OpenAPI spec: /api/v1/schema/?format=json for client generators.
  • Any page: use Copy page at the top of the page.

A prompt you can paste into Claude Code or Codex in your own repository:

Prompt
Read https://mypacehub.com/llms-full.txt. It is the complete documentation of the PACE Partner API.
Write a small client for it in this repository:
1. Read PACE_CLIENT_ID and PACE_CLIENT_SECRET from the environment, never hardcode them.
2. Get a token with the client credentials grant and cache it until 60 seconds before it expires.
3. Call GET /api/v1/me/ and print the organisation and environment.
4. Retry once on 401 with a fresh token. On 429 wait for Retry-After seconds.
Follow the documentation exactly and do not invent endpoints that it does not list.

Reference