Skip to main content
BackedHelp Centre

A developer site and an OpenAPI document for the Backed API - Product News

The Backed API now has a public developer site with a full reference, guides and a changelog, and an OpenAPI document on your organisation's own address.

Published

ForIntegrationsAdministrators

What's new

  • A developer site. https://backed.giving/developers documents the whole Backed API: every read and write route with request and response examples, guides to signing in, paging, errors, idempotency keys, webhook signatures, Power BI and Tableau, the webhook Event catalogue and a Changelog of every API change with its date. It is public and needs no sign-in. See Developer documentation.
  • An OpenAPI document. The API is described in one OpenAPI 3.1 document, at your organisation's own address plus /api/v2/openapi.json and on the developer site. Developers can generate a client from it or import it into their API tools, and it needs no credential.
  • Pages for AI assistants. The developer site publishes llms.txt, llms-full.txt and a Markdown copy of every page, so an AI assistant can read the documentation as it helps write an integration.
  • A link from API Access. The API Access tab under Settings > Profile and terms now links to the developer site under Developer documentation. See API access.