Brands
list
brands.list
List the brands of the studio
Risk: read
items full type
items full type
meta full type
meta full type
Jobs
create
jobs.create
Create a lead or job with its type, lead source, brand and event date
Risk: write
clientContacts full type
clientContacts full type
contacts full type
contacts full type
links full type
links full type
delete
jobs.delete
Permanently delete a job with its orders, invoices and notes
Risk: destructive · Irreversible
get
jobs.get
Read one job with its contacts, orders, invoices and totals
Risk: read
clientContacts full type
clientContacts full type
contacts full type
contacts full type
links full type
links full type
list
jobs.list
List jobs with their stage, balances and event dates, filtered by stage, lead status or event date range
Risk: read
items full type
items full type
meta full type
meta full type
payments
jobs.payments
List the payments recorded against one job
Risk: read
items full type
items full type
meta full type
meta full type
update
jobs.update
Change a job’s stage, dates, type, lead source, brand or closed state
Risk: write
clientContacts full type
clientContacts full type
contacts full type
contacts full type
links full type
links full type
Job Types
list
jobTypes.list
List the job types, whose IDs jobs.create takes
Risk: read
items full type
items full type
meta full type
meta full type
Lead Sources
list
leadSources.list
List the lead sources, for reporting where a lead came from
Risk: read
items full type
items full type
meta full type
meta full type
Lead Statuses
list
leadStatuses.list
List the lead statuses, whose IDs jobs.list filters by
Risk: read
items full type
items full type
meta full type
meta full type
Notes
create
notes.create
Add an HTML note to a job or a contact
Risk: write
delete
notes.delete
Permanently delete a note
Risk: destructive · Irreversible
list
notes.list
List notes, optionally only those on one job
Risk: read
items full type
items full type
meta full type
meta full type
Payments
create
payments.create
Record a payment against a job, which changes that job balance
Risk: write
links full type
links full type
delete
payments.delete
Delete a payment, which removes it from the job balance
Risk: destructive · Irreversible
get
payments.get
Read one payment with its refunded amount and memo
Risk: read
links full type
links full type
list
payments.list
List payments with their job, amount, status and method
Risk: read
items full type
items full type
meta full type
meta full type
update
payments.update
Change a payment’s status, memo, method or payer; the amount is read-only, so to fix it delete the payment and record it again (the delete cannot be undone and the new payment gets a new id)
Risk: write
links full type
links full type
Products
create
products.create
Add a product to the price list
Risk: write
delete
products.delete
Delete a product; orders that already include it keep their line item
Risk: destructive · Irreversible
get
products.get
Read one product with its price, SKU and flags
Risk: read
list
products.list
List the products in your price list
Risk: read
items full type
items full type
meta full type
meta full type
update
products.update
Change a product’s name, price, SKU or flags
Risk: write
Studio
get
studio.get
Read the studio profile, including its currency and timezone
Risk: read
links full type
links full type
Task Lists
list
taskLists.list
List the task lists, whose IDs tasks.create takes
Risk: read
items full type
items full type
meta full type
meta full type
Tasks
create
tasks.create
Create a task in a task list, optionally on a job
Risk: write
links full type
links full type
delete
tasks.delete
Permanently delete a task
Risk: destructive · Irreversible
list
tasks.list
List tasks with their list, assignee and due date
Risk: read
items full type
items full type
meta full type
meta full type
update
tasks.update
Change a task’s name, assignee, due date or completed state
Risk: write
links full type
links full type