Introduction

All backend implementations need to adhere to our API spec. The full API is described in the OpenAPI spec.

For your convenience, we have a Hurl collection that you can use to test your API endpoints as you build your app. You can run them all with run-api-tests-hurl.sh.

The tests are the source of truth

These pages summarize the contract in prose, but the OpenAPI spec and the Hurl suite are what actually define it. Where the prose and the tests disagree, the tests win — so build against them, and if you find a discrepancy, please open an issue.

Once you’re set up, read the rest of the backend specification: Endpoints, API response format, and Error handling. You can also start from our starter kit.