API docs
Sous Chef Onboarding API
Request access

API conventions

These rules hold everywhere on this API. Learn them once and every operation reads the same.

One path per operation, everything in the body

Every operation is a POST to a fixed, verb-first path with a typed JSON request object. No path parameters, no query strings. A request is therefore fully described by its URL and its body, which makes it easy to log, replay and diff.

No version segment

The base path carries no /v1. Changes are additive: new optional fields and new operations are added, and nothing published is removed or narrowed. Ignore fields you do not recognise and your client keeps working across releases.

Ignore unknown fields

We add optional fields to existing request and response objects at any time. A new field always has a defined meaning when absent, so an older client stays correct. It only has less information.

Opening hours are local times

Opening hours are 24-hour HH:mm in the location's own IANA timezone, which you send on createLocation. This API has no timestamp fields.