Skip to main content

Feathr API

The Feathr API is a standalone REST service for programmatic access to your Feathr account — campaigns, projects, persons, breadcrumbs, tags, and custom fields.

  • Base URL: https://api.feathr.co (see your account for the exact host).
  • Format: JSON request and response bodies over HTTPS.
  • Auth: an opaque API key sent as a bearer token. See Authentication.
  • Spec: the full, machine-readable contract lives in the API Reference, generated from the service's OpenAPI 3.1 schema.

Conventions​

These conventions hold across every endpoint:

  • Authentication — every request carries Authorization: Bearer <key>. Each key is scoped; a request to an endpoint your key is not scoped for is rejected with 403.
  • Pagination — list endpoints are offset-based and return a Page envelope: an items array plus page, size, and total. Request successive pages by incrementing the page query parameter (size defaults to 25, max 100) until page * size >= total.
  • Errors — failures use RFC 7807 problem documents (application/problem+json) with a type, title, status, and detail.

Next steps​