Read Zenbooker jobs, customers, invoices and timeslots; add customers and job notes.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: add an internal note (text) to a job. Notes are appended, never replaced, and cannot be deleted through this server, so check the job first. POST /v1/jobs/{id}/notes.
The note text.
The Zenbooker id (the id field of a list result).
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: add an internal note (text) to a job. Notes are appended, never replaced, and cannot be deleted through this server, so check the job first. POST /v1/jobs/{id}/notes.
| Argument | Type | Description |
|---|---|---|
| text* | string | The note text. |
| job_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id",
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "The note text."
},
"job_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}Check whether a location is inside the business's service area: returns in_service_area, the matching territory and other territories that serve it (or the closest territory when it is outside every area). Give a postal code, an address, or lat + lng. GET /v1/scheduling/service_area_check.
| Argument | Type | Description |
|---|---|---|
| lat | number | Latitude; send together with lng. |
| lng | number | Longitude; send together with lat. |
| address | string | Street address (needed only when there is no postal code or lat/lng). |
| postal_code | string | ZIP or postal code. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Latitude; send together with lng."
},
"lng": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Longitude; send together with lat."
},
"address": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "Street address (needed only when there is no postal code or lat/lng)."
},
"postal_code": {
"type": "string",
"maxLength": 20,
"minLength": 1,
"description": "ZIP or postal code."
}
}
}WRITE: create a new customer record in Zenbooker (name required; phone and email optional). It does not look for an existing customer, so search with zenbooker_list_customers first to avoid duplicates. POST /v1/customers.
| Argument | Type | Description |
|---|---|---|
| name* | string | The customer's name. |
| string | The customer's email address. | |
| phone | string | The customer's default phone number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The customer's name."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 3,
"description": "The customer's email address."
},
"phone": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The customer's default phone number."
}
}
}One customer by id: contact details, notes, addresses, job and recurring booking ids and linked Stripe customer. GET /v1/customers/{id}.
| Argument | Type | Description |
|---|---|---|
| customer_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One invoice by id: recipient, line items, discounts, tax, totals, amount paid and due, status and transactions. GET /v1/invoices/{id}.
| Argument | Type | Description |
|---|---|---|
| invoice_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"invoice_id"
],
"properties": {
"invoice_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One job by id: appointment time, status, customer, service address, services and fields, assigned providers, notes and invoice summary. GET /v1/jobs/{id}.
| Argument | Type | Description |
|---|---|---|
| job_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One recurring booking by id: first job date, job count, time slot, status, territory, service, pricing and its job ids. GET /v1/recurring/{id}.
| Argument | Type | Description |
|---|---|---|
| recurring_booking_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"recurring_booking_id"
],
"properties": {
"recurring_booking_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One service by id: pricing, duration, option sections and their options. GET /v1/services/{id}.
| Argument | Type | Description |
|---|---|---|
| service_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"service_id"
],
"properties": {
"service_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One team member by id: contact details, role, status, territories, skill tags and work hours. GET /v1/team_members/{id}.
| Argument | Type | Description |
|---|---|---|
| team_member_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"team_member_id"
],
"properties": {
"team_member_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}One service territory by id. GET /v1/territories/{id}.
| Argument | Type | Description |
|---|---|---|
| territory_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"territory_id"
],
"properties": {
"territory_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}Available booking time slots for a service territory, grouped by day (days[].timeslots[] with start, end and id). Needs the territory id (zenbooker_list_territories or zenbooker_check_service_area) and the service duration in minutes. GET /v1/scheduling/timeslots.
| Argument | Type | Description |
|---|---|---|
| lat | number | Customer latitude (for drive-time aware availability); send with lng. |
| lng | number | Customer longitude; send with lat. |
| date | string | First day to check, yyyy-mm-dd (default today). |
| days | integer | How many days to return (default 7, max 60). |
| duration* | integer | Service length in minutes (required). |
| territory* | string | The service territory id (required). |
| required_skills | string | Comma-separated skill tag ids a provider must have. |
| service_providers | string | Comma-separated team member ids to restrict slots to. |
One payment transaction by id: status, type, method, amount, invoice and customer ids, Stripe references. GET /v1/transactions/{id}.
| Argument | Type | Description |
|---|---|---|
| transaction_id* | string | The Zenbooker id (the id field of a list result). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"transaction_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The Zenbooker id (the id field of a list result)."
}
}
}List or search customers by name, email or phone, by creation time, or by default address near a place (location + radius in miles). Returns { results, count, has_more, next_cursor }. GET /v1/customers.
| Argument | Type | Description |
|---|---|---|
| name | string | Search by customer name. |
| string | Search by customer email. | |
| limit | integer | Results per page, 1-100 (default 20). |
| phone | string | Search by phone number. |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| radius | integer | Search radius in miles, used with location. |
| location | string | A place or address; finds customers whose default address is near it (geocoded by Zenbooker). |
| sort_order | string | Sort order (default ascending). |
| created_after | string | Only items created after this ISO 8601 date-time. |
List invoices, optionally by status (draft, unpaid, partial_paid, paid, void), customer id, territory id or creation time. Each invoice has line items, totals, amount paid and due and its transactions. Returns { results, count, has_more, next_cursor }. GET /v1/invoices.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| status | string | Only invoices in this status (default: any status). |
| sort_by | string | Sort field (default creation_date). |
| customer | string | Only invoices of this customer id. |
| territory | string | Only invoices in this service territory id. |
| sort_order | string | Sort order (default ascending). |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before |
List jobs (booked appointments), by start time by default, with filters: customer id, assigned team member id, territory id, recurring booking id, status, canceled flag, creation time and scheduled start window. Returns { results, count, has_more, next_cursor }; pass next_cursor as cursor for the next page. GET /v1/jobs.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| status | string | Only jobs with this status. |
| sort_by | string | Sort field (default start_time). |
| assigned | string | Only jobs assigned to this team member (service provider) id. |
| canceled | boolean | true = only canceled jobs, false = only jobs that are not canceled. |
| customer | string | Only jobs of this customer id. |
| territory | string | Only jobs in this service territory id. |
List recurring bookings (repeating job series), by status (active or canceled), customer id, assigned team member id, territory id or creation time. Max 40 per page. Returns { results, count, has_more, next_cursor }. GET /v1/recurring.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-40 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| status | string | Only recurring bookings with this status. |
| assigned | string | Only recurring bookings assigned to this team member id. |
| customer | string | Only recurring bookings of this customer id. |
| territory | string | Only recurring bookings in this service territory id. |
| sort_order | string | Sort order (default ascending). |
| created_after | string | Only items created after this ISO 8601 date-time. |
List incoming service requests (booking requests and quote requests) with status, customer, territory, duration, requested dates, services and pricing. Returns { results, count, has_more, next_cursor }. GET /v1/service_requests.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| customer | string | Only requests of this customer id. |
| territory | string | Only requests in this service territory id. |
| sort_order | string | Sort order (default ascending). |
| request_type | string | Only this kind of request. |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
List the services a business offers, with pricing method, base price and duration, option sections and recurring frequencies. GET /v1/services.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| is_visible | boolean | true = only services visible in online booking. |
| sort_order | string | Sort order (default ascending). |
| category_id | string | Only services in this category id. |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"is_visible": {
"type": "boolean",
"description": "true = only services visible in online booking."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"category_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only services in this category id."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}List team members (staff and service providers) with role, status, assigned territories, skill tags and work hours. Use the ids to filter jobs by assigned provider. GET /v1/team_members.
| Argument | Type | Description |
|---|---|---|
| string | Find a team member by email address. | |
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| territory | string | Only providers assigned to this service territory id. |
| sort_order | string | Sort order (default ascending). |
| deactivated | boolean | true = only deactivated team members, false = only active ones. |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
| service_provider |
List the service territories (areas a business serves) with timezone, service area, providers and operating hours. Use the ids to filter jobs and invoices or to look up time slots. GET /v1/territories.
| Argument | Type | Description |
|---|---|---|
| name | string | Search by territory name. |
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| enabled | boolean | true = only active territories, false = only deactivated ones (default both). |
| sort_order | string | Sort order (default ascending). |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search by territory name."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"enabled": {
"type": "boolean",
"description": "true = only active territories, false = only deactivated ones (default both)."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}List payment transactions, optionally by type (stripe_payment, external_transaction), payment method, status (succeeded, failed, voided), customer id, territory id, creation time or payment date. Returns { results, count, has_more, next_cursor }. GET /v1/transactions.
| Argument | Type | Description |
|---|---|---|
| type | string | Only transactions of this type. |
| limit | integer | Results per page, 1-100 (default 20). |
| cursor | integer | Where to start in the list (default 0). Pass the previous reply's next_cursor. |
| status | string | Only transactions in this status. |
| sort_by | string | Sort field (default creation_date). |
| customer | string | Only transactions of this customer id. |
| territory | string | Only transactions in this service territory id. |
| sort_order | string | Sort order (default ascending). |
| created_after |
| timeslot_template | string | A timeslot template id. |
| min_providers_needed | integer | Minimum number of providers a slot needs (default 1). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"territory",
"duration"
],
"properties": {
"lat": {
"type": "number",
"maximum": 90,
"minimum": -90,
"description": "Customer latitude (for drive-time aware availability); send with lng."
},
"lng": {
"type": "number",
"maximum": 180,
"minimum": -180,
"description": "Customer longitude; send with lat."
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First day to check, yyyy-mm-dd (default today)."
},
"days": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "How many days to return (default 7, max 60)."
},
"duration": {
"type": "integer",
"maximum": 10000,
"minimum": 1,
"description": "Service length in minutes (required)."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "The service territory id (required)."
},
"required_skills": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Comma-separated skill tag ids a provider must have."
},
"service_providers": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Comma-separated team member ids to restrict slots to."
},
"timeslot_template": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "A timeslot template id."
},
"min_providers_needed": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Minimum number of providers a slot needs (default 1)."
}
}
}| created_before | string | Only items created before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search by customer name."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Search by customer email."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"phone": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Search by phone number."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"radius": {
"type": "integer",
"maximum": 1000,
"minimum": 1,
"description": "Search radius in miles, used with location."
},
"location": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "A place or address; finds customers whose default address is near it (geocoded by Zenbooker)."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}| string |
| Only items created before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"status": {
"enum": [
"draft",
"unpaid",
"partial_paid",
"paid",
"void"
],
"type": "string",
"description": "Only invoices in this status (default: any status)."
},
"sort_by": {
"enum": [
"creation_date",
"total_paid",
"total_due"
],
"type": "string",
"description": "Sort field (default creation_date)."
},
"customer": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only invoices of this customer id."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only invoices in this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}| sort_order |
| string |
| Sort order (default ascending). |
| created_after | string | Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
| start_date_max | string | Only jobs scheduled to start on or before this ISO 8601 date-time. |
| start_date_min | string | Only jobs scheduled to start on or after this ISO 8601 date-time. |
| recurring_booking | string | Only jobs that belong to this recurring booking id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"status": {
"enum": [
"Scheduled",
"En-route",
"Started",
"Complete"
],
"type": "string",
"description": "Only jobs with this status."
},
"sort_by": {
"enum": [
"start_time",
"creation_date"
],
"type": "string",
"description": "Sort field (default start_time)."
},
"assigned": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only jobs assigned to this team member (service provider) id."
},
"canceled": {
"type": "boolean",
"description": "true = only canceled jobs, false = only jobs that are not canceled."
},
"customer": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only jobs of this customer id."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only jobs in this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
},
"start_date_max": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only jobs scheduled to start on or before this ISO 8601 date-time."
},
"start_date_min": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only jobs scheduled to start on or after this ISO 8601 date-time."
},
"recurring_booking": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only jobs that belong to this recurring booking id."
}
}
}| created_before |
| string |
| Only items created before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 40,
"minimum": 1,
"description": "Results per page, 1-40 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"status": {
"enum": [
"active",
"canceled"
],
"type": "string",
"description": "Only recurring bookings with this status."
},
"assigned": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only recurring bookings assigned to this team member id."
},
"customer": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only recurring bookings of this customer id."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only recurring bookings in this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"customer": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only requests of this customer id."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only requests in this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"request_type": {
"enum": [
"booking_request",
"quote_request"
],
"type": "string",
"description": "Only this kind of request."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
}
}
}| boolean |
| true = only team members who can be assigned jobs. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Find a team member by email address."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only providers assigned to this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"deactivated": {
"type": "boolean",
"description": "true = only deactivated team members, false = only active ones."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
},
"service_provider": {
"type": "boolean",
"description": "true = only team members who can be assigned jobs."
}
}
}| string |
| Only items created after this ISO 8601 date-time. |
| created_before | string | Only items created before this ISO 8601 date-time. |
| payment_method | string | Only transactions paid by this method. |
| transaction_date_after | string | Only transactions dated after this ISO 8601 date-time. |
| transaction_date_before | string | Only transactions dated before this ISO 8601 date-time. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"enum": [
"stripe_payment",
"external_transaction"
],
"type": "string",
"description": "Only transactions of this type."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 20)."
},
"cursor": {
"type": "integer",
"maximum": 2147483647,
"minimum": 0,
"description": "Where to start in the list (default 0). Pass the previous reply's next_cursor."
},
"status": {
"enum": [
"succeeded",
"failed",
"voided"
],
"type": "string",
"description": "Only transactions in this status."
},
"sort_by": {
"enum": [
"creation_date",
"total_paid",
"total_due"
],
"type": "string",
"description": "Sort field (default creation_date)."
},
"customer": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only transactions of this customer id."
},
"territory": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Only transactions in this service territory id."
},
"sort_order": {
"enum": [
"ascending",
"descending"
],
"type": "string",
"description": "Sort order (default ascending)."
},
"created_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created after this ISO 8601 date-time."
},
"created_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only items created before this ISO 8601 date-time."
},
"payment_method": {
"enum": [
"stripe",
"credit_card",
"check",
"cash",
"custom"
],
"type": "string",
"description": "Only transactions paid by this method."
},
"transaction_date_after": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only transactions dated after this ISO 8601 date-time."
},
"transaction_date_before": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?(Z|[+-]\\d{2}:\\d{2})?)?$",
"description": "Only transactions dated before this ISO 8601 date-time."
}
}
}