Partner API · v0

GP Code Partner API

Create GP codes for your customers straight from your own systems — from a map pin or a street address — and hand them a short code and a QR that point to the exact spot.

The Partner API is a server-to-server REST API. It uses predictable resource URLs, accepts and returns JSON, uses standard HTTP verbs and status codes, and authenticates every request with an API key and secret issued to your organisation by GP Code.

Getting startedYour first GP code in three requests.

AuthenticationAPI keys, secrets, scopes and IP allowlists.

GP codes referenceCreate, list, update and delete codes.

ErrorsEvery error code and what to do about it.

What you can build

Delivery and logistics — give every drop-off point a code your drivers can open on a map.
Real estate, events and venues — print a QR that leads guests to the right gate or entrance.
E-commerce and booking — create a code for each customer address during checkout and store it alongside the order.

Every code you create has a public page at https://gpcode.com/<code> and a ready-to-print QR image that encodes that URL.

Base URL

All endpoints are relative to the base URL of the environment you are calling:

Environment	Base URL	Keys
Production	`{{BASE}}`	`gpk_live_…`
Staging	`{{SANDBOX}}`	`gpk_test_…`

Staging is a separate systemStaging has its own database. Keys, users and codes created there do not exist in production, and vice versa. Build and test against staging, then switch the base URL and key when you go live.

Endpoints

GET/me/quotaRemaining allowance POST/usersCreate a user GET/usersList users GET/users/{id}Retrieve a user POST/gp-codesCreate a code GET/gp-codesList codes GET/gp-codes/{code}Retrieve a code (with QR) PATCH/gp-codes/{code}Update a code DELETE/gp-codes/{code}Delete a code

Key concepts

GP codes

A GP code is a short string that resolves to a place: coordinates, an address and optional details such as house number or phone. A standard code is assigned from the GP Code pool and is live immediately. A custom code is a string you choose (4–30 letters and digits); it is reviewed by GP Code and goes live once approved. Codes are unique per country.

Users

A user represents one of your customers. You identify it with your own external_ref (a customer, booking or order id). Users created through the API cannot log in to GP Code; they exist only to group the codes you create for that customer. You can also create codes without a user — they then belong to your partner account.

Quota

Every code you create, whoever owns it, counts against your organisation's allowance agreed in your partner contract. Deleting a code frees its place. When the allowance is used up, creation fails with 402 quota_exhausted and nothing is written. See Quota.

Scoping

You only ever see your own users and the codes you created. Anything else answers 404 not_found — the API never confirms that another partner's record exists.

Get access

API keys are issued by GP Code under a partner agreement. Write to {{SUPPORT}} with your company name, a technical contact, the environments you need and, if you want one, the IP addresses your servers call from. You will receive a key and a secret for staging first.