Daybook DocsDaybook Docs
Browse

API reference

A REST API over JSON: predictable resources, bearer keys, idempotent writes and signed webhooks.

Base URL

text
https://api.daybookhealthcare.com/v1

OpenAPI spec

The whole API as an OpenAPI 3.1 document, for code generators, API clients and agents: /docs/openapi.json. Every docs page is also plain Markdown at its own URL with .md on the end, such as /docs/quickstart.md.

Conventions

Metadata

Most objects take metadata: up to 20 keys of your own, such as your account, ticket or claim id. Metadata is echoed on the object and on every event about it, so your webhook handler never needs a lookup table. Keep it to ids: a patient's name, date of birth or member id belongs in the request's own fields, never in metadata, which is echoed everywhere and will land in your logs.

Pagination

List endpoints return data and has_more. Pass the last id as starting_after for the next page.

On this pageBase URLOpenAPI specConventionsMetadataPagination