# Swikly API

> REST API to create and manage requests holding deposits, no-shows and payments, to reclaim or refund them, and to read the accounts and users they belong to.

The human reference at `/v1/docs` renders the OpenAPI specification with JavaScript and carries no text of its own, so read the specification below instead.
Every endpoint is authenticated with an `Authorization: Bearer <API key>` header, the key being created from the Swikly "Applications and integrations" > "Developer" panel.
Base URLs: `https://api.v2.swikly.com/v1` in production, `https://api.sandbox.swikly.com/v1` in sandbox.

## Docs

- [OpenAPI 3.1 specification](/openapi/v1/openapi.yaml): the whole contract as YAML — endpoints, parameters, request and response schemas, error payloads, and the introductory guide rendered at `/v1/docs`.

## Status

- [Status page](https://status.swikly.com/): availability of the production and sandbox APIs, and where an incident is published while it lasts.