API Overview - Culper

The Culper API is a read-only, campaign-scoped REST API. Every request is authenticated with a campaign API key and can only ever read that campaign’s data.

Beta. The Walks endpoints are live. Lists, Outdoor (signs), and SMS reporting are documented here but not yet active — they’ll switch on as they ship.

Base URL

https://theculpernetwork.com/api/v1

Response shape

Every response is one of two envelopes:

{ "ok": true, "data": { /* … */ }, "meta": { /* optional */ } }

{ "ok": false, "error": { "code": "not_found", "message": "Walk not found." } }

Error codes

HTTP	`error.code`	Meaning
400	`bad_request`	Malformed input (e.g. an invalid id).
401	`unauthorized`	Missing or invalid API key.
403	`forbidden`	The key lacks the required scope.
404	`not_found`	Resource doesn’t exist or isn’t in your campaign.
429	`rate_limited`	Too many requests.
500	`server_error`	Something went wrong on our end.

Conventions

Read-only. Every endpoint is GET. The API never writes.
Campaign-scoped. The campaign is inferred from your API key — you never pass a campaign id.
Pagination. List endpoints accept ?limit (default 50, max 200).
HTTPS only. Requests over plain HTTP are rejected.
Versioned. The current version is v1 (in the path). Breaking changes ship as a new version.

Authentication

How to create and use your API key.