API referenceBeta

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring

maximum length: 100 · Case-insensitive starts-with search: first name, last name, "first last", email, company name or phone (typed with or without dashes) starts with q. Text from the middle of a field does not match; for a name that may be misspelled use search.list. %, _ are treated as ordinary text.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

local_idinteger

minimum: 1 · Exact business-local number within this operation’s record family; it is never compared with an API ID.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

sortstring

enum: "id", "lifetime_spend", "last_order_at" · Allowed sort field, applied to all matching customers before the page limit. lifetime_spend ranks by amount actually paid (use with direction=desc for top spenders); last_order_at by most recent appointment or job, customers with none last. Omission keeps the default id ascending order.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the customer ID as a stable tie-breaker.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customerstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the customer path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customerstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the customer path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customerstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the customer path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring

maximum length: 100 · Case-insensitive bounded text search; omission performs no text filtering.

statusstring

enum: "waiting", "in_work", "processed", "does_not_answer", "deleted" · Code-owned lifecycle state filter; omission includes every allowed state.

fromstring

format: "date" · Inclusive lower business-local date.

tostring

format: "date" · Inclusive upper business date, or documented exclusive instant where stated.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

leadstringRequired

pattern: "^lead_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`lead_...`) of the business-owned lead.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

leadstringRequired

pattern: "^lead_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`lead_...`) of the business-owned lead.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

attachmentstringRequired

pattern: "^attachment_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`attachment_...`) of the attachment metadata row.

parent_typeAttachmentParentTypeRequired

Code-owned parent record family; combine it with the parent ID.

parent_idstringRequired

pattern: "^(?:appointment|job|request|visit|customer|vehicle|task)_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_...`, `job_...`, `request_...`, `visit_...`, `customer_...`, `vehicle_...` or `task_...`) within the supplied parent_type used to reauthorize a download.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

parent_typeAttachmentParentTypeRequired

Code-owned parent record family; combine it with the parent ID.

parentstringRequired

pattern: "^(?:appointment|job|request|visit|customer|vehicle|task)_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_...`, `job_...`, `request_...`, `visit_...`, `customer_...`, `vehicle_...` or `task_...`) within the selected parent_type.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

parent_typeAttachmentParentTypeRequired

Code-owned parent record family; combine it with the parent ID.

parentstringRequired

pattern: "^(?:appointment|job|request|visit|customer|vehicle|task)_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_...`, `job_...`, `request_...`, `visit_...`, `customer_...`, `vehicle_...` or `task_...`) within the selected parent_type.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customerstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the owned customer conversation or portal summary.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

fromstring

format: "date" · Inclusive business-local start date.

tostring

format: "date" · Inclusive business-local end date; endpoint range limits apply.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Filter by owned customer API ID (`customer_...`).

local_idinteger

minimum: 1 · Filter by business-local display number, distinct from API IDs.

worker_idstring

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Filter by assigned worker user API ID (`user_...`).

statusstring

enum: "waiting", "inprocess", "done", "onhold", "canceled" · Filter by documented business state.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "start_at", "created_at", "updated_at" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

service_idstring

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Match any attached appointment service product belonging to this business. The response service_id retains the canonical lowest attached API ID (`appointment_service_...`).

assignmentstring

enum: "assigned", "unassigned" · Whether an in-business worker association exists; unassigned cannot combine with worker_id or worker_q.

worker_qstring

minimum length: 1; maximum length: 100 · Literal substring of the worker’s name in this business; requires team.read.

payment_statestring

enum: "unpaid", "paid", "paid_cash", "declined", "partially_refunded", "refunded" · Appointment payment state, distinct from work status. paid does not include paid_cash.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Appointment API ID (`appointment_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

service_idstringRequired

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Active owned Appointment Service API ID (`appointment_service_...`) whose bookable arrival windows are requested.

datestringRequired

format: "date" · Business-local date in YYYY-MM-DD form.

date_tostring

format: "date" · Optional inclusive business-local end date. When supplied, returns per-date availability for at most 14 consecutive days in one response.

worker_idsarray

minimum items: 1; items must be unique · API IDs (`user_...`) of distinct active worker candidates. A window is bookable when at least one candidate is free; the server selects one candidate when the appointment is saved.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Filter by owned customer API ID (`customer_...`).

local_idinteger

minimum: 1 · Filter by business-local display number, distinct from API IDs.

frequencyAppointmentSeriesFrequency

Filter by recurrence cadence.

lifecycle_statusstring

enum: "active", "paused", "ended" · Filter active, paused, or ended definitions.

fromstring

format: "date" · Inclusive business-local start date.

tostring

format: "date" · Inclusive business-local end date; endpoint range limits apply.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^appointment_series_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Series API ID (`appointment_series_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

activeboolean

Filter Appointment Services by active or inactive booking state.

qstring

maximum length: 100 · Literal case-insensitive contains search within Appointment Service titles; %, _, and = are treated as ordinary text.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointment_servicestringRequired

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Service API ID (`appointment_service_...`).

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointment_servicestringRequired

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Service API ID (`appointment_service_...`).

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointment_servicestringRequired

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Appointment Service API ID (`appointment_service_...`).

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring

maximum length: 100 · Literal case-insensitive contains search within Job Service names; %, _, and = are treated as ordinary text.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

fromstringRequired

format: "date" · First included business-local date, in YYYY-MM-DD form; for example 2026-12-01.

tostringRequired

format: "date" · Last included business-local date, in YYYY-MM-DD form. Must be on or after from and no more than 90 days later; longer intervals return validation_failed for to.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

datestringRequired

format: "date" · Exact closed business-local date in YYYY-MM-DD form.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

datestringRequired

format: "date" · Exact date identifying the closure within this business, for example 2026-12-25. Use YYYY-MM-DD in the business timezone, not a UTC timestamp or numeric record ID.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

datestringRequired

format: "date" · Exact date identifying the closure within this business, for example 2026-12-25. Use YYYY-MM-DD in the business timezone, not a UTC timestamp or numeric record ID.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Filter by owned customer API ID (`customer_...`).

service_idstring

pattern: "^job_service_[0-9a-hjkmnp-tv-z]{26}$" · Filter by the root Request’s owned Job Service API ID (`job_service_...`).

local_idinteger

minimum: 1 · Filter by the Job’s own internal number, which is never shown; to find a job by the number owners see, use project_number.

project_numberinteger

minimum: 1 · Filter by project number (the root Request’s number) — the number owners call “job #158”.

worker_idstring

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Filter by assigned worker user API ID (`user_...`).

statusstring

enum: "submit", "cancel", "approve", "draft", "in-progress", "complete", "scheduled", "in_progress" · Filter by documented business state.

fromstring

format: "date" · Inclusive business-local start date.

tostring

format: "date" · Inclusive business date; when paired with from the range is at most 366 days.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "preferred_start_at", "created_at", "updated_at" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

assignmentstring

enum: "assigned", "unassigned" · Whether a worker association exists in this business, including historical memberships. unassigned cannot combine with a worker filter.

worker_qstring

minimum length: 1; maximum length: 100 · Literal substring of the business-specific worker first, last or full name; requires team.read. Does not assign anyone.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the current-business job; it is distinct from the job's local_id.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the current-business job; it is distinct from the job's local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the current-business job; it is distinct from the job's local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the current-business job; it is distinct from the job's local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the current-business job; it is distinct from the job's local_id.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Filter by owned customer API ID (`customer_...`).

service_idstring

pattern: "^job_service_[0-9a-hjkmnp-tv-z]{26}$" · Filter by the root Request’s owned Job Service API ID (`job_service_...`).

local_idinteger

minimum: 1 · Filter by business-local display number, distinct from API IDs.

statusstring

enum: "submit", "cancel", "approve", "draft", "in-progress", "complete", "scheduled", "in_progress" · Filter by documented business state.

fromstring

format: "date" · Inclusive business-local start date.

tostring

format: "date" · Inclusive business date; when paired with from the range is at most 366 days.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "preferred_start_at", "created_at", "updated_at" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

include_convertedboolean

default: false · false (default) omits Requests already converted to a Job, as the Requests page does. true also returns them (became_job true); their status stays as it was when converted, usually submit.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

work_requeststringRequired

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · Request API ID (`request_...`), not local_id.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

work_requeststringRequired

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · Request API ID (`request_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

work_requeststringRequired

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`request_...`) of the current-business Request; it is distinct from the Request local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

work_requeststringRequired

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · Request API ID (`request_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

work_requeststringRequired

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`request_...`) of the current-business request; it is distinct from the request's local_id.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Filter by owned customer API ID (`customer_...`).

service_idstring

pattern: "^job_service_[0-9a-hjkmnp-tv-z]{26}$" · Filter by the root Request’s owned Job Service API ID (`job_service_...`).

local_idinteger

minimum: 1 · Filter by business-local display number, distinct from API IDs.

project_numberinteger

minimum: 1 · Filter by project number (the root Request’s number): every visit of “Project #158”.

worker_idstring

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Filter by assigned worker user API ID (`user_...`).

statusstring

enum: "submit", "cancel", "approve", "draft", "in-progress", "complete", "scheduled", "in_progress" · Filter by documented business state.

fromstring

format: "date" · Inclusive business-local start date.

tostring

format: "date" · Inclusive business date; when paired with from the range is at most 366 days.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "preferred_start_at", "created_at", "updated_at" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

assignmentstring

enum: "assigned", "unassigned" · Whether a worker association exists in this business, including historical memberships. unassigned cannot combine with a worker filter.

worker_qstring

minimum length: 1; maximum length: 100 · Literal substring of the business-specific worker first, last or full name; requires team.read. Does not assign anyone.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · Visit API ID (`visit_...`), not local_id.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · Visit API ID (`visit_...`), not local_id.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · Visit API ID (`visit_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · Visit API ID (`visit_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · Visit API ID (`visit_...`), not local_id.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

visitstringRequired

pattern: "^visit_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`visit_...`) of the current-business visit; it is distinct from the visit's local_id.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_...`) of the owned Appointment parent.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

appointmentstringRequired

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_...`) of the owned Appointment parent.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

itemstringRequired

pattern: "^checklist_item_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_item_...`) of a checklist step, resolved through its owning checklist and work.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

itemstringRequired

pattern: "^checklist_item_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_item_...`) of a checklist step, resolved through its owning checklist and work.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

itemstringRequired

pattern: "^checklist_item_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_item_...`) of a checklist step, resolved through its owning checklist and work.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

templatestringRequired

pattern: "^checklist_template_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_template_...`) of the active checklist template owned by this business.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

statestring

default: "all"; enum: "unfinished", "finished", "all" · unfinished = checklists with at least one open item (or no items yet); finished = every item done or N/A; all = both. Default all.

parent_typestring

enum: "job", "appointment" · Only checklists on Jobs or only on Appointments. Omitted: both, limited to the parents this credential may read.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

checkliststringRequired

pattern: "^checklist_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_...`) of the checklist owned by this business.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

checkliststringRequired

pattern: "^checklist_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_...`) of the checklist owned by this business.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

checkliststringRequired

pattern: "^checklist_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`checklist_...`) of the checklist owned by this business.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the owned Job parent.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

jobstringRequired

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`job_...`) of the owned Job parent.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

request_idstring

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`request_...`) of the related work request.

statusstring

enum: "waiting-approval", "approved", "changes-requested", "rejected", "expired", "canceled", "draft", "archived" · Exact public lifecycle state to include.

fromstring

format: "date" · Inclusive first business-local date in the requested range.

tostring

format: "date" · Inclusive last business-local date in the requested range.

local_idinteger

minimum: 1 · Exact business-local number within this operation’s record family; it is never compared with an API ID.

project_numberinteger

minimum: 1 · Filter by project number (the related Request’s number), shown as “Project #158”.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "created_at", "quote_date", "expires_on", "total" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

job_idstring

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · Exact job API ID (`job_...`) in this business; matches documents belonging to that job’s request. This is not a direct document foreign key.

amount_minstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Minimum tax-inclusive document total in dollars, inclusive.

amount_maxstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Maximum tax-inclusive document total in dollars, inclusive; must not be below amount_min.

include_summaryboolean

default: false · Include a fixed summary over ALL records matching these filters, before sorting and pagination. Default false. Zero matches returns zero totals.

expires_fromstring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive estimate expiration calendar date bound; paired range at most366days. Legacy from/to still filters quote_date.

expires_tostring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive estimate expiration calendar date bound; paired range at most366days. Legacy from/to still filters quote_date.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

estimatestringRequired

pattern: "^estimate_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`estimate_...`) of the estimate path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

estimatestringRequired

pattern: "^estimate_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`estimate_...`) of the estimate path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

estimatestringRequired

pattern: "^estimate_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`estimate_...`) of the estimate path resource.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

estimatestringRequired

pattern: "^estimate_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`estimate_...`) of the estimate path resource.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

templatestringRequired

pattern: "^estimate_template_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`estimate_template_...`) of the estimate-template path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

request_idstring

pattern: "^request_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`request_...`) of the related work request.

statusstring

enum: "voided", "paid", "paid_cash", "overdue", "refunded", "partially_refunded", "due", "pending", "declined", "disputed", "draft", "uncollectable" · Exact public lifecycle state to include.

fromstring

format: "date" · Inclusive first business-local date in the requested range.

tostring

format: "date" · Inclusive last business-local date in the requested range.

local_idinteger

minimum: 1 · Exact business-local number within this operation’s record family; it is never compared with an API ID.

project_numberinteger

minimum: 1 · Filter by project number (the related Request’s number), shown as “Project #158”.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "created_at", "total", "balance_due", "payment_due_on" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

job_idstring

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · Exact job API ID (`job_...`) in this business; matches documents belonging to that job’s request. This is not a direct document foreign key.

amount_minstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Minimum tax-inclusive document total in dollars, inclusive.

amount_maxstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Maximum tax-inclusive document total in dollars, inclusive; must not be below amount_min.

include_summaryboolean

default: false · Include a fixed summary over ALL records matching these filters, before sorting and pagination. Default false. Zero matches returns zero totals.

balance_minstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Minimum canonical remaining balance, inclusive.

balance_maxstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Maximum canonical remaining balance, inclusive.

issued_fromstring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive first Invoice Date (issued_on: the date picked on the invoice form, or the creation date). Due dates use completion date (or creation date) plus due_days. New paired ranges are limited to 366 days.

issued_tostring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive last Invoice Date (issued_on: the date picked on the invoice form, or the creation date). Due dates use completion date (or creation date) plus due_days. New paired ranges are limited to 366 days.

due_fromstring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive first payment due calendar date. Due dates use completion date (or creation date) plus due_days. New paired ranges are limited to 366 days.

due_tostring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive last payment due calendar date. Due dates use completion date (or creation date) plus due_days. New paired ranges are limited to 366 days.

overdueboolean

Positive canonical balance with payment_due_on before today in the business timezone, excluding draft, voided, refunded and uncollectable. false selects the complement.

payment_statestring

enum: "unpaid", "partial", "paid" · Based on canonical total, net paid and remaining balance; excludes draft/voided/refunded/uncollectable and zero totals. paid does not infer payment from status alone.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

invoicestringRequired

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`invoice_...`) of the invoice path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

invoicestringRequired

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`invoice_...`) of the invoice path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

invoicestringRequired

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`invoice_...`) of the invoice path resource.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum log lines returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

invoicestringRequired

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`invoice_...`) of the invoice path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

kindstring

enum: "appointment", "invoice" · Required record family discriminator; the payment's API ID must belong to this kind.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

statusstring

enum: "created", "pending", "success", "failed", "canceled", "partially_refunded", "refunded", "declined", "disputed" · Exact public lifecycle state to include.

fromstring

format: "date" · Inclusive first business-local date in the requested range.

tostring

format: "date" · Inclusive last business-local date in the requested range.

local_idinteger

minimum: 1 · Exact business-local number within this operation’s record family; it is never compared with an API ID. Requires kind=appointment because invoice payments have no business-local number.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

sortstring

enum: "id", "created_at", "succeeded_at", "amount" · Allowed sort field, applied to all matching records before the page limit. Omission preserves the existing default ordering.

directionstring

enum: "asc", "desc" · Sort direction; requires sort. Explicit sorting defaults to asc and uses the record ID as a stable tie-breaker.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · Match any listed status (OR), combined with other filters (AND). Send statuses[]=value. Do not combine with status.

representationstring

default: "full"; enum: "full", "compact" · full preserves the existing detailed shape. compact returns scalar list fields without child collections; retrieve one record separately for details.

include_summaryboolean

default: false · Include a fixed summary over ALL records matching these filters, before sorting and pagination. Default false. Zero matches returns zero totals.

amount_minstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Minimum stored payment-attempt amount, inclusive, in dollars.

amount_maxstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Maximum stored payment-attempt amount, inclusive.

invoice_idstring

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · Parent invoice API ID (`invoice_...`); implies invoice kind and cannot combine with appointment_id or contradictory kind.

appointment_idstring

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Parent appointment API ID (`appointment_...`); implies appointment kind and requires appointments.read.

date_fieldstring

enum: "created", "succeeded" · Select the date filtered by from/to. created uses business-local days compared with the stored business-clock creation time and includes failed/pending records with no success date. succeeded uses the established business-wall-clock success timestamp. Omission preserves legacy success-date filtering.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

kindstringRequired

enum: "appointment", "invoice" · Required record family discriminator; the payment's API ID must belong to this kind.

paymentstringRequired

pattern: "^(?:payment|invoice_payment)_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_...` or `invoice_payment_...`) within the explicit payment kind.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

service_idstring

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`appointment_service_...`) of the owned service snapshot source.

lifecycle_statusstring

enum: "active", "paused", "ended" · Current recurring-series state: active, paused, or ended.

frequencystring

enum: "weekly", "2_weeks", "4_weeks", "monthly", "quarterly", "6_months", "yearly" · Filters definitions by the cadence used to calculate their future scheduled dates.

local_idinteger

minimum: 1 · Exact business-local number within this operation’s record family; it is never compared with an API ID.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

seriesstringRequired

pattern: "^payment_series_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`payment_series_...`) of the recurring payment series.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_qstring

minimum length: 1; maximum length: 100 · Literal case-insensitive substring of customer first, last or full name within this business; requires customers.read. Multiple matches are returned, never automatically selected. % and _ are literal characters.

payment_idstring

pattern: "^(?:invoice_payment|payment)_[0-9a-hjkmnp-tv-z]{26}$" · Exact parent payment API ID (`invoice_payment_...` or `payment_...`); payment_kind must also be provided.

payment_kindstring

enum: "invoice", "appointment" · Parent payment family; incompatible parent filters are rejected.

invoice_idstring

pattern: "^invoice_[0-9a-hjkmnp-tv-z]{26}$" · Parent invoice API ID (`invoice_...`); implies invoice payment kind.

appointment_idstring

pattern: "^appointment_[0-9a-hjkmnp-tv-z]{26}$" · Parent appointment API ID (`appointment_...`); implies appointment payment kind and requires appointments.read.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Customer API ID (`customer_...`) from the parent invoice or appointment.

statusstring

enum: "created", "complete", "processing", "failed" · Exact stored refund status.

statusesarray

minimum items: 1; maximum items: 12; items must be unique · OR of stored statuses; cannot combine with status. Send statuses[]=value.

date_fieldstring

default: "created"; enum: "created", "completed" · Date filtered by from/to; business-local days are compared with the stored business-clock time. Null completion dates do not match bounded completion filters.

fromstring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive first business-local calendar day.

tostring

format: "date"; pattern: "^[1-9][0-9]{3}-[0-9]{2}-[0-9]{2}$" · Inclusive last business-local day; paired range at most366days.

sortstring

enum: "id", "created_at", "completed_at", "amount" · Allowed sort; omission returns newest-created first. Explicit nullable sorts place null last.

directionstring

enum: "asc", "desc" · Requires sort; explicit sorting defaults to asc with ID tie-breaker.

pageinteger

default: 1; minimum: 1 · One-based page number.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum rows on this page, not the matching total.

amount_minstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Inclusive minimum refund amount in dollars.

amount_maxstring

pattern: "^[0-9]{1,10}(\\.[0-9]{1,2})?$" · Inclusive maximum refund amount; must not be below amount_min.

include_summaryboolean

default: false · Include a fixed summary over ALL records matching these filters, before sorting and pagination. Default false. Zero matches returns zero totals.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

refundstringRequired

pattern: "^refund_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`refund_...`) of the customer refund, not a payment ID or platform billing refund.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

include_retiredstring

enum: "true", "false", "1", "0" · When true, include retired tax rates alongside active rates.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

categorystringRequired

pattern: "^price_book_category_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`price_book_category_...`) of the price-book category path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

categorystringRequired

pattern: "^price_book_category_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`price_book_category_...`) of the price-book category path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring | null

maximum length: 100 · Case-insensitive text search over the documented business-facing fields.

category_idstring

pattern: "^price_book_category_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`price_book_category_...`) of an owned price-book category.

typePriceBookItemType

Exact supported domain type to include.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

itemstringRequired

pattern: "^price_book_item_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`price_book_item_...`) of the price-book item path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

itemstringRequired

pattern: "^price_book_item_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`price_book_item_...`) of the price-book item path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

fromstring

format: "date" · Inclusive lower business-local date.

tostring

format: "date" · Inclusive upper business-local date.

directionstring

enum: "incoming", "outgoing" · Only incoming or only outgoing calls.

statusstring

enum: "answered", "missed", "voicemail", "ai_answered", "outbound_answered", "outbound_missed", "in_progress" · Only calls with this outcome.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`); only calls with this customer.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the owned customer whose conversations are listed. Required.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customerstringRequired

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of the owned customer conversation or portal summary.

channelConversationChannel

Code-owned conversation channel key.

fromstring

format: "date" · Inclusive lower business-local date.

tostring

format: "date" · Inclusive upper business date, or documented exclusive instant where stated.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

statusstring

enum: "active", "completed", "all" · Code-owned lifecycle state filter; omission includes every allowed state.

fromstring

format: "date" · Inclusive lower business-local date.

tostring

format: "date" · Inclusive upper business date, or documented exclusive instant where stated.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

callstringRequired

pattern: "^receptionist_call_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`receptionist_call_...`) of the stored receptionist call.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

statestring

enum: "needs_approval", "handled", "all" · Code-owned lifecycle state filter; omission includes every allowed state.

fromstring

format: "date" · Inclusive lower business-local date.

tostring

format: "date" · Inclusive upper business date, or documented exclusive instant where stated.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

replystringRequired

pattern: "^receptionist_reply_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`receptionist_reply_...`) of the stored receptionist reply review.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of an owned customer used to narrow results.

statusstring

enum: "open", "resolved", "expired", "all" · Ticket state filter; omission returns open tickets only. Use all for every state.

fromstring

format: "date" · Inclusive lower business-local date on the ticket's created date.

tostring

format: "date" · Inclusive upper business-local date on the ticket's created date; not before from.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

ticketstringRequired

pattern: "^ticket_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`ticket_...`) of the business-owned ticket.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

ticketstringRequired

pattern: "^ticket_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`ticket_...`) of the business-owned ticket.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`customer_...`) of an owned customer used to narrow results.

contactstring

maximum length: 320 · Stored follow-up contact label used as an exact filter.

statestring

enum: "waiting", "done", "all" · Code-owned lifecycle state filter; omission includes every allowed state.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

follow_upstringRequired

pattern: "^follow_up_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`follow_up_...`) of the business-owned follow-up.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

follow_upstringRequired

pattern: "^follow_up_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`follow_up_...`) of the business-owned follow-up.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

scopestring

default: "own"; enum: "own", "team" · Select the caller’s own tasks or the authorized team view.

sectionstring

enum: "unassigned", "overdue", "all_open", "completed" · Filter team tasks by unassigned, overdue, all_open, or completed. Requires scope=team; omit section for scope=own.

qstring | null

maximum length: 100 · Case-insensitive text search over the documented business-facing fields.

assignee_user_idstring

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`user_...`) of an eligible business user.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

context_typeTaskContextType

Exact linked-record family paired with work_id.

due_fromstring

format: "date" · Inclusive first business-local due date.

due_tostring

format: "date" · Inclusive last business-local due date.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

scopestring

enum: "own", "team" · Select the caller’s own tasks or the authorized team view.

qstring | null

maximum length: 100 · Case-insensitive text search over the documented business-facing fields.

assignee_user_idstring

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`user_...`) of an eligible business user.

customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of the related customer.

context_typeTaskContextType

Exact linked-record family paired with work_id.

due_fromstring

format: "date" · Inclusive first business-local due date.

due_tostring

format: "date" · Inclusive last business-local due date.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

taskstringRequired

pattern: "^task_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`task_...`) of the task path resource; never a business-local number.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

activeboolean

default: true · Filter active state; inactive team rows require manager access.

qstring

maximum length: 100 · Literal case-insensitive contains name search; manager-level team search may also match email. %, _, and = are treated as ordinary text.

service_idstring

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Filter active workers eligible for this owned Appointment Service API ID (`appointment_service_...`).

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

user_idstringRequired

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Worker user API ID (`user_...`), not membership_id.

activeboolean

default: true · Filter active state; inactive team rows require manager access.

qstring

maximum length: 100 · Literal case-insensitive contains name search; manager-level team search may also match email. %, _, and = are treated as ordinary text.

service_idstring

pattern: "^appointment_service_[0-9a-hjkmnp-tv-z]{26}$" · Filter active workers eligible for this owned Appointment Service API ID (`appointment_service_...`).

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

user_idstringRequired

pattern: "^user_[0-9a-hjkmnp-tv-z]{26}$" · Worker user API ID (`user_...`), not membership_id.

fromstringRequired

format: "date" · Inclusive business-local start date.

tostringRequired

format: "date" · Inclusive business-local end date; endpoint range limits apply.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

folderstringRequired

pattern: "^note_folder_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_folder_...`) of the note-folder path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring | null

maximum length: 100 · Case-insensitive text search over the documented business-facing fields.

folder_idstring

pattern: "^note_folder_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`note_folder_...`) of an owned note folder.

linked_customer_idstring

pattern: "^customer_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`customer_...`) of an owned customer linked to the note.

linked_job_idstring

pattern: "^job_[0-9a-hjkmnp-tv-z]{26}$" · Exact API ID (`job_...`) of an owned job linked to the note.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

linkstringRequired

pattern: "^note_link_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_link_...`) of the note-link path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

notestringRequired

pattern: "^note_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`note_...`) of the note path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

activeboolean

Filters by active/inactive state when supplied; omission includes both states.

qstring | null

maximum length: 100 · Case-insensitive bounded text search; omission performs no text filtering.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

accidentstringRequired

pattern: "^vehicle_accident_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_accident_...`) of the accident under the parent vehicle.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

alarmstringRequired

pattern: "^vehicle_alarm_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_alarm_...`) of the alarm under the parent vehicle.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

alarmstringRequired

pattern: "^vehicle_alarm_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_alarm_...`) of the alarm under the parent vehicle.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

alarmstringRequired

pattern: "^vehicle_alarm_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_alarm_...`) of the alarm under the parent vehicle.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

expensestringRequired

pattern: "^vehicle_expense_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_expense_...`) of the expense under the parent vehicle.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

maintenancestringRequired

pattern: "^vehicle_maintenance_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_maintenance_...`) of the maintenance row under the parent vehicle.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

maintenancestringRequired

pattern: "^vehicle_maintenance_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_maintenance_...`) of the maintenance row under the parent vehicle.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vehiclestringRequired

pattern: "^vehicle_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vehicle_...`) of the parent vehicle; nested IDs are valid only under this vehicle.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

qstring

maximum length: 100 · Literal case-insensitive contains search over the documented business-facing fields; %, _, and = are treated as ordinary text.

pageinteger

default: 1; minimum: 1 · One-based page number for this stable ordered result set.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records returned per page, from 1 through 100.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

Idempotency-KeystringRequired

format: "uuid" · A stable UUID for the same logical request. Reusing it with different input returns 409. Mutation retry window: 24 hours; receipts retained for 30 days.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vendorstringRequired

pattern: "^vendor_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vendor_...`) of the vendor path resource.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

vendorstringRequired

pattern: "^vendor_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`vendor_...`) of the vendor path resource.

If-MatchstringRequired

minimum length: 1 · The opaque ETag from the latest record read. Missing: 428; stale: 412.

BizBaby sets it: the ETag from your latest read of this record.

Idempotency-Keystring

format: "uuid" · Optional for PUT, PATCH and DELETE. Supply a stable UUID to obtain the same safe receipt/replay behavior as POST. Reuse it only for identical input within the 24-hour retry window.

Your software makes it: a new UUID for each change.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

audiencestringRequired

pattern: "^audience_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`audience_...`) of the stored marketing audience.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

campaignstringRequired

pattern: "^campaign_[0-9a-hjkmnp-tv-z]{26}$" · API ID (`campaign_...`) of the delivery campaign.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

business_idstringRequired

pattern: "^business_[0-9a-hjkmnp-tv-z]{26}$" · The business's API ID (`business_...`). The server rejects a different business; this path parameter cannot switch tenants. Trusted clients obtain it from their connection rather than asking the owner.

pageinteger

default: 1; minimum: 1 · One-based page number within the currently filtered result set. Keep the same filters when following subsequent pages.

per_pageinteger

default: 25; minimum: 1; maximum: 100 · Maximum records to return on this page. This limits page size, not the full filtered total.