REST API reference

Tradify API

15 endpoints for Tradify. Each one is a POST with a JSON body, called with your API key.

Base URL: https://cotlet.dev/api/v1/tradify
Connects with: Your own Tradify account (an admin or office user for quotes, invoices and the Scheduler)
Integration page: Tradify

Tradify Endpoints
Endpoint	Access	Description
list_jobs	read	Jobs with number, customer, site address, status and assigned staff.
get_job	read	Full job: description, site, tasks, notes, appointments, costs, linked quotes and invoices.
list_customers	read	Customer profiles with contact details and sites.
list_quotes	read	Quotes with customer, total, quote date, expiry date and status.
list_invoices	read	Invoices with customer, job, due date, total, amount paid and amount due.
list_appointments	read	Scheduler appointments in a date range, with staff, job, times and notes.
create_customer	write	New customer profile, optionally with a site address.
create_job	write	New job for a customer. It starts as Unassigned.
update_job_status	write	Set a manual status on a job, or one of your custom statuses.
create_quote	write	Draft quote with line items. Nothing is sent until you call send_quote.
send_quote	write	Approve the quote and email it to the customer with a link to accept or decline online.
create_invoice_from_quote	write	Draft invoice from an accepted quote, for all of it or part of it.
send_invoice	write	Approve the invoice and email it to the customer, with payment reminders if enabled.
record_payment	write	Record a payment received against an invoice. Syncs to your accounting app if connected.
schedule_appointment	write	Book a job appointment on the Scheduler for staff, optionally emailing the customer a confirmation.

List jobs

read

POST https://cotlet.dev/api/v1/tradify/list_jobs

Lists jobs with their number, customer, site address, status and assigned staff. By default it returns active jobs; set status to see to-invoice, on hold, complete or cancelled jobs. Pages hold up to 100 jobs; pass next_cursor back as cursor for the next page.

Parameters

Parameters: list_jobs
Name	Type	Description
status	enum	active, unassigned, assigned, scheduled, in_progress, to_invoice, on_hold, complete or cancelled. Default: active.
customer_id	string	Only jobs for this customer.
search	string	Match job number, customer or description.
limit	integer	1 to 100. Default: 50.
cursor	string	Next page cursor from the previous call.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/list_jobs \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("tradify", "list_jobs")

const result = await cotlet.call('tradify', 'list_jobs');

cotlet call tradify list_jobs

Example response

{
  "jobs": [
    {
      "job_id": "j_20931",
      "number": "J-0418",
      "customer": "Sam Lee",
      "site_address": "12 Oak St",
      "status": "scheduled",
      "staff": [
        "Mike Ross"
      ],
      "description": "Replace hot water cylinder"
    }
  ],
  "next_cursor": null
}

Get job

read

POST https://cotlet.dev/api/v1/tradify/get_job

Returns one job with its description, site, tasks, notes, appointments, costs and the quotes and invoices linked to it. Use it before changing a job so your agent sees its current state.

Parameters

Parameters: get_job
Name	Type	Description
job_id required	string	Job ID from list_jobs.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/get_job \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"job_8c41d2"}'

result = client.call("tradify", "get_job", {"job_id":"job_8c41d2"})

const result = await cotlet.call('tradify', 'get_job', {"job_id":"job_8c41d2"});

cotlet call tradify get_job --data '{"job_id":"job_8c41d2"}'

Example response

{
  "job_id": "j_20931",
  "number": "J-0418",
  "customer": "Sam Lee",
  "site_address": "12 Oak St",
  "status": "scheduled",
  "description": "Replace hot water cylinder",
  "appointments": [
    {
      "staff": [
        "Mike Ross"
      ],
      "start": "2026-10-15T08:00:00+13:00",
      "end": "2026-10-15T12:00:00+13:00"
    }
  ],
  "quotes": [
    "q_90102"
  ],
  "invoices": []
}

List customers

read

POST https://cotlet.dev/api/v1/tradify/list_customers

Lists customer profiles with contact details and sites. Search matches name, email or phone, so your agent can find the customer ID before creating a job or quote.

Parameters

Parameters: list_customers
Name	Type	Description
search	string	Match name, email or phone.
limit	integer	1 to 100. Default: 50.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/list_customers \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("tradify", "list_customers")

const result = await cotlet.call('tradify', 'list_customers');

cotlet call tradify list_customers

Example response

{
  "customers": [
    {
      "customer_id": "c_48120",
      "name": "Sam Lee",
      "email": "sam@example.com",
      "phone": "021 555 0142",
      "sites": [
        "12 Oak St"
      ]
    }
  ]
}

List quotes

read

POST https://cotlet.dev/api/v1/tradify/list_quotes

Lists quotes with customer, total, quote date, expiry date and status. By default it returns quotes awaiting acceptance; use status accepted with a since date to find quotes accepted in a period.

Parameters

Parameters: list_quotes
Name	Type	Description
status	enum	draft, awaiting_acceptance, accepted, expired or cancelled. Default: awaiting_acceptance.
since	date	Only quotes dated on or after this date.
limit	integer	1 to 100. Default: 50.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/list_quotes \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("tradify", "list_quotes")

const result = await cotlet.call('tradify', 'list_quotes');

cotlet call tradify list_quotes

Example response

{
  "quotes": [
    {
      "quote_id": "q_90314",
      "number": "Q-1042",
      "customer": "Sam Lee",
      "total": "752.10",
      "quote_date": "2026-10-09",
      "expiry_date": "2026-11-09",
      "status": "accepted"
    }
  ]
}

List invoices

read

POST https://cotlet.dev/api/v1/tradify/list_invoices

Lists invoices with customer, job, due date, total, amount paid and amount due. Amount due is total minus amount paid. By default it returns approved invoices; use status overdue to chase late payers.

Parameters

Parameters: list_invoices
Name	Type	Description
status	enum	draft, approved, overdue or paid. Default: approved.
customer_id	string	Only invoices for this customer.
limit	integer	1 to 100. Default: 50.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/list_invoices \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"overdue"}'

result = client.call("tradify", "list_invoices", {"status":"overdue"})

const result = await cotlet.call('tradify', 'list_invoices', {"status":"overdue"});

cotlet call tradify list_invoices --data '{"status":"overdue"}'

Example response

{
  "invoices": [
    {
      "invoice_id": "inv_7781",
      "number": "INV-2210",
      "customer": "Priya Patel",
      "job": "J-0402",
      "due_date": "2026-09-30",
      "total": "420.00",
      "paid": "0.00",
      "due": "420.00",
      "status": "overdue"
    },
    {
      "invoice_id": "inv_7790",
      "number": "INV-2219",
      "customer": "Tom Hale",
      "job": "J-0409",
      "due_date": "2026-10-02",
      "total": "980.00",
      "paid": "300.00",
      "due": "680.00",
      "status": "overdue"
    }
  ]
}

List appointments

read

POST https://cotlet.dev/api/v1/tradify/list_appointments

Returns Scheduler appointments between two dates, each with staff, job, start and end times and notes. The range is at most 31 days. Pass staff names to see only those people.

Parameters

Parameters: list_appointments
Name	Type	Description
from required	date	First day.
to required	date	Last day, up to 31 days after from.
staff	string[]	Only these staff members, by name.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/list_appointments \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-10-01","to":"2026-10-01"}'

result = client.call("tradify", "list_appointments", {"from":"2026-10-01","to":"2026-10-01"})

const result = await cotlet.call('tradify', 'list_appointments', {"from":"2026-10-01","to":"2026-10-01"});

cotlet call tradify list_appointments --data '{"from":"2026-10-01","to":"2026-10-01"}'

Example response

{
  "appointments": [
    {
      "staff": [
        "Mike Ross"
      ],
      "job": "J-0418",
      "start": "2026-10-13T08:00:00+13:00",
      "end": "2026-10-13T12:00:00+13:00",
      "notes": "Bring new cylinder"
    }
  ]
}

Create customer

write

POST https://cotlet.dev/api/v1/tradify/create_customer

Creates a customer profile, optionally with a site address. It reaches no one and stays inside Tradify, so it runs without asking first.

Parameters

Parameters: create_customer
Name	Type	Description
name required	string	Customer or company name.
email	string	Email for quotes and invoices.
phone	string	Phone number.
address	string	Postal or site address.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/create_customer \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Jane Doe"}'

result = client.call("tradify", "create_customer", {"name":"Jane Doe"})

const result = await cotlet.call('tradify', 'create_customer', {"name":"Jane Doe"});

cotlet call tradify create_customer --data '{"name":"Jane Doe"}'

Example response

{
  "customer_id": "c_48177",
  "name": "Priya Patel",
  "status": "created"
}

Create job

write

POST https://cotlet.dev/api/v1/tradify/create_job

Creates a job for a customer. The new job starts as Unassigned until an appointment or staff is added. It reaches no one and stays inside Tradify, so it runs without asking first.

Parameters

Parameters: create_job
Name	Type	Description
customer_id required	string	Customer ID from list_customers or create_customer.
description required	string	What the work is.
site_address	string	Job address if different from the customer.
reference	string	Your reference, e.g. a PO number.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/create_job \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"customer_8c41d2","description":"description"}'

result = client.call("tradify", "create_job", {"customer_id":"customer_8c41d2","description":"description"})

const result = await cotlet.call('tradify', 'create_job', {"customer_id":"customer_8c41d2","description":"description"});

cotlet call tradify create_job --data '{"customer_id":"customer_8c41d2","description":"description"}'

Example response

{
  "job_id": "j_20931",
  "number": "J-0418",
  "customer": "Sam Lee",
  "site_address": "12 Oak St",
  "description": "Replace hot water cylinder",
  "status": "unassigned"
}

Update job status

write

POST https://cotlet.dev/api/v1/tradify/update_job_status

Sets a manual status on a job: to_invoice, on_hold, complete, cancelled or the name of one of your custom statuses. It reaches no one and one more call sets it back, so it runs without asking first.

Parameters

Parameters: update_job_status
Name	Type	Description
job_id required	string	Job ID from list_jobs.
status required	string	to_invoice, on_hold, complete, cancelled or the name of a custom status.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/update_job_status \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"job_8c41d2","status":"status"}'

result = client.call("tradify", "update_job_status", {"job_id":"job_8c41d2","status":"status"})

const result = await cotlet.call('tradify', 'update_job_status', {"job_id":"job_8c41d2","status":"status"});

cotlet call tradify update_job_status --data '{"job_id":"job_8c41d2","status":"status"}'

Example response

{
  "job_id": "j_20931",
  "status": "complete"
}

Create quote

write

POST https://cotlet.dev/api/v1/tradify/create_quote

Creates a draft quote with line items of type time, misc, price list or kit. Expiry date defaults to your expiry days setting. The quote stays a draft inside Tradify until send_quote, so it runs without asking first.

Parameters

Parameters: create_quote
Name	Type	Description
customer_id required	string	Customer ID.
line_items required	object	List of items: type (misc, time, price_list or kit), description, quantity, unit price or billing rate.
description	string	Shown on the quote.
expiry_date	date	Default: your expiry days setting.
tax_inclusive	boolean	Prices include tax. Default: false.
job_id	string	Link the quote to an existing job.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/create_quote \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"c_48120","description":"Bathroom rewire, 6 downlights and extractor fan","line_items":[{"type":"time","description":"Electrician labour","quantity":6,"billing_rate":"Standard"},{"type":"misc","description":"LED downlights","quantity":6,"unit_price":"24.00"}],"tax_inclusive":false}'

result = client.call("tradify", "create_quote", {"customer_id":"c_48120","description":"Bathroom rewire, 6 downlights and extractor fan","line_items":[{"type":"time","description":"Electrician labour","quantity":6,"billing_rate":"Standard"},{"type":"misc","description":"LED downlights","quantity":6,"unit_price":"24.00"}],"tax_inclusive":False})

const result = await cotlet.call('tradify', 'create_quote', {"customer_id":"c_48120","description":"Bathroom rewire, 6 downlights and extractor fan","line_items":[{"type":"time","description":"Electrician labour","quantity":6,"billing_rate":"Standard"},{"type":"misc","description":"LED downlights","quantity":6,"unit_price":"24.00"}],"tax_inclusive":false});

cotlet call tradify create_quote --data '{"customer_id":"c_48120","description":"Bathroom rewire, 6 downlights and extractor fan","line_items":[{"type":"time","description":"Electrician labour","quantity":6,"billing_rate":"Standard"},{"type":"misc","description":"LED downlights","quantity":6,"unit_price":"24.00"}],"tax_inclusive":false}'

Example response

{
  "quote_id": "q_90314",
  "number": "Q-1042",
  "status": "draft",
  "customer": "Sam Lee",
  "lines": [
    {
      "description": "Electrician labour",
      "quantity": 6,
      "amount": "510.00"
    },
    {
      "description": "LED downlights",
      "quantity": 6,
      "amount": "144.00"
    }
  ],
  "subtotal": "654.00",
  "tax": "98.10",
  "total": "752.10",
  "expiry_date": "2026-11-09"
}

Send quote

write Confirm

POST https://cotlet.dev/api/v1/tradify/send_quote

Approves a draft quote and emails it to the customer with a link to accept or decline online. The email text defaults to your quote email template. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: send_quote
Name	Type	Description
quote_id required	string	Quote ID from list_quotes.
message	string	Email text. Default: your quote email template.
send_me_a_copy	boolean	Copy to your own email. Default: false.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/send_quote \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"quote_8c41d2"}'

result = client.call("tradify", "send_quote", {"quote_id":"quote_8c41d2"})

const result = await cotlet.call('tradify', 'send_quote', {"quote_id":"quote_8c41d2"});

cotlet call tradify send_quote --data '{"quote_id":"quote_8c41d2"}'

Example response

{
  "quote_id": "q_90314",
  "status": "awaiting_acceptance",
  "emailed_to": "sam@example.com"
}

Create invoice from quote

write

POST https://cotlet.dev/api/v1/tradify/create_invoice_from_quote

Creates a draft invoice from an accepted quote. Mode entire invoices everything, remaining invoices what is not yet invoiced, percentage and fixed_amount take amount, and line_items picks lines. The invoice stays a draft until send_invoice, so it runs without asking first.

Parameters

Parameters: create_invoice_from_quote
Name	Type	Description
quote_id required	string	Quote ID from list_quotes.
mode required	enum	entire, remaining, percentage, fixed_amount or line_items.
amount	string	Percent or fixed amount, for those modes.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/create_invoice_from_quote \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"q_90314","mode":"percentage","amount":"30"}'

result = client.call("tradify", "create_invoice_from_quote", {"quote_id":"q_90314","mode":"percentage","amount":"30"})

const result = await cotlet.call('tradify', 'create_invoice_from_quote', {"quote_id":"q_90314","mode":"percentage","amount":"30"});

cotlet call tradify create_invoice_from_quote --data '{"quote_id":"q_90314","mode":"percentage","amount":"30"}'

Example response

{
  "invoice_id": "inv_7802",
  "number": "INV-2231",
  "quote_id": "q_90314",
  "status": "draft",
  "total": "225.63"
}

Send invoice

write Confirm

POST https://cotlet.dev/api/v1/tradify/send_invoice

Approves a draft invoice and emails it to the customer, with payment reminders if you enabled them. The email text defaults to your invoice email template. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: send_invoice
Name	Type	Description
invoice_id required	string	Invoice ID from list_invoices.
message	string	Email text. Default: your invoice email template.
send_me_a_copy	boolean	Copy to your own email. Default: false.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/send_invoice \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"invoice_8c41d2"}'

result = client.call("tradify", "send_invoice", {"invoice_id":"invoice_8c41d2"})

const result = await cotlet.call('tradify', 'send_invoice', {"invoice_id":"invoice_8c41d2"});

cotlet call tradify send_invoice --data '{"invoice_id":"invoice_8c41d2"}'

Example response

{
  "invoice_id": "inv_7802",
  "status": "approved",
  "emailed_to": "sam@example.com"
}

Record payment

write Confirm

POST https://cotlet.dev/api/v1/tradify/record_payment

Records a payment received against an invoice and reduces the amount due. If your accounting app is connected, the payment syncs to it. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: record_payment
Name	Type	Description
invoice_id required	string	Invoice ID from list_invoices.
amount required	string	Amount received.
date	date	Payment date. Default: today.
method	string	Payment method name from your settings.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/record_payment \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"invoice_8c41d2","amount":"amount"}'

result = client.call("tradify", "record_payment", {"invoice_id":"invoice_8c41d2","amount":"amount"})

const result = await cotlet.call('tradify', 'record_payment', {"invoice_id":"invoice_8c41d2","amount":"amount"});

cotlet call tradify record_payment --data '{"invoice_id":"invoice_8c41d2","amount":"amount"}'

Example response

{
  "invoice_id": "inv_7781",
  "payment_id": "pay_5530",
  "amount": "420.00",
  "date": "2026-10-11",
  "method": "Bank transfer",
  "due": "0.00",
  "status": "paid"
}

Schedule appointment

write Confirm

POST https://cotlet.dev/api/v1/tradify/schedule_appointment

Books a job appointment on the Scheduler for the staff you name; with no staff the appointment is unassigned. Set email_customer to send the customer a confirmation, otherwise nothing is emailed. By default you confirm each call; you can switch that off for this tool.

Parameters

Parameters: schedule_appointment
Name	Type	Description
job_id required	string	Job ID from list_jobs.
start required	datetime	ISO 8601 with time zone.
end required	datetime	ISO 8601 with time zone.
staff	string[]	Staff member names. Empty: unassigned appointment.
notes	string	Notes for the crew.
email_customer	boolean	Send the customer an email confirmation. Default: false.

Request

cURL Python Node.js CLI

curl -X POST https://cotlet.dev/api/v1/tradify/schedule_appointment \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id":"j_20931","start":"2026-10-15T09:30:00+13:00","end":"2026-10-15T13:30:00+13:00","staff":["Mike Ross"],"notes":"Bring 180 L cylinder","email_customer":true}'

result = client.call("tradify", "schedule_appointment", {"job_id":"j_20931","start":"2026-10-15T09:30:00+13:00","end":"2026-10-15T13:30:00+13:00","staff":["Mike Ross"],"notes":"Bring 180 L cylinder","email_customer":True})

const result = await cotlet.call('tradify', 'schedule_appointment', {"job_id":"j_20931","start":"2026-10-15T09:30:00+13:00","end":"2026-10-15T13:30:00+13:00","staff":["Mike Ross"],"notes":"Bring 180 L cylinder","email_customer":true});

cotlet call tradify schedule_appointment --data '{"job_id":"j_20931","start":"2026-10-15T09:30:00+13:00","end":"2026-10-15T13:30:00+13:00","staff":["Mike Ross"],"notes":"Bring 180 L cylinder","email_customer":true}'

Example response

{
  "appointment_id": "ap_3318",
  "job_id": "j_20931",
  "staff": [
    "Mike Ross"
  ],
  "start": "2026-10-15T08:00:00+13:00",
  "end": "2026-10-15T12:00:00+13:00",
  "customer_emailed": false
}

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Parameters

Request

Example response

Analytics cookies