Data model

Sourdoughs

A single sourdough starter. Carries identity (name, source, started_at), recipe defaults (flour_type, hydration_pct), state (last_fed_at, retired) and presentation (color, avatar_blob_id, tags, favorite). Acts as the parent for every log_entry in the starter's continuous journal.

Model name: sourdough

Endpoints: 5

Max page size: 200

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

Field	Type	Constraints
mode	`enum`	enum`establishing \| maintenance \| activating \| baking`
name	`string`	max length`120`
slug	`string`	max length`120`
tags	`tags`	-
color	`string`	max length`24`
notes	`string`	max length`8000`
source	`string`	max length`200`
retired	`bool`	-
favorite	`bool`	-
flour_type	`enum`	enum`white \| whole_wheat \| rye \| spelt \| einkorn \| khorasan \| mixed \| other`
started_at	`string`	max length`32`
last_fed_at	`string`	max length`32`
establish_day	`number`	-
feeding_ratio	`string`	max length`32`
hydration_pct	`number`	-
ambient_temp_c	`number`	-
computed_state	`string`	max length`64`
bake_target_date	`string`	max length`32`
feeding_freq_hours	`number`	-
establish_started_at	`string`	max length`32`
establish_step_done_at	`string`	max length`64`
establish_next_remind_at	`string`	max length`64`

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.

Field	Type	Create	Patch
mode	enum
name	string
slug	string
tags	tags
color	string
notes	string
source	string
retired	bool
favorite	bool
flour_type	enum
started_at	string
last_fed_at	string
establish_day	number
feeding_ratio	string
hydration_pct	number
ambient_temp_c	number
computed_state	string
bake_target_date	string
feeding_freq_hours	number
establish_started_at	string
establish_step_done_at	string
establish_next_remind_at	string

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?status=open&status=blocked&sort=-created_at.

Filter keys

namedata__name

slugdata__slug

flour_typedata__flour_type

retireddata__retired

favoritedata__favorite

tagsdata__tags

statusstatus

is_archivedis_archived

owned_byowned_by

Sort keys

created_atcreated_at

updated_atupdated_at

namedata__name

started_atdata__started_at

last_fed_atdata__last_fed_at

Default: name

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/sourdoughsourdough:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

curl -H "Authorization: Bearer pat_…" \
     "https://sourdoughtracker.com/xapi2/data/sourdough?limit=20"

GET/xapi2/data/sourdough/{id}sourdough:read

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://sourdoughtracker.com/xapi2/data/sourdough/OBJECT_ID

POST/xapi2/data/sourdoughsourdough:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://sourdoughtracker.com/xapi2/data/sourdough \
     -d '{"name": "…"}'

PATCH/xapi2/data/sourdough/{id}sourdough:update

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://sourdoughtracker.com/xapi2/data/sourdough/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/sourdough/{id}sourdough:delete

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://sourdoughtracker.com/xapi2/data/sourdough/OBJECT_ID

Use in CLI

The same endpoints are also exposed via the Sourdough Tracker CLI. For scripts, CI, and bulk imports it's usually the faster path.

sourdoughcli sourdough list --limit 5
sourdoughcli sourdough get <id>
sourdoughcli sourdough create --name "Hello"
sourdoughcli sourdough upsert --unique name --csv items.csv
sourdoughcli sourdough schema   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli