Skip to main content
New to Corsair? See API access, authentication, and error handling.

Brands

list

brands.list List the brands of the studio Risk: read
Input Output

Jobs

create

jobs.create Create a lead or job with its type, lead source, brand and event date Risk: write
Input stage defaults to the studio pipeline start; jobTypeId and leadSourceId come from their list routes. Output

delete

jobs.delete Permanently delete a job with its orders, invoices and notes Risk: destructive · Irreversible
Input Removes the job with its orders, invoices and notes; it cannot be undone. Output

get

jobs.get Read one job with its contacts, orders, invoices and totals Risk: read
Input Output

list

jobs.list List jobs with their stage, balances and event dates, filtered by stage, lead status or event date range Risk: read
Input Returns leads and jobs together; stage accepts lead, booked, fulfillment and completed, and closed jobs need includeClosed. Output

payments

jobs.payments List the payments recorded against one job Risk: read
Input Output

update

jobs.update Change a job’s stage, dates, type, lead source, brand or closed state Risk: write
Input Output

Job Types

list

jobTypes.list List the job types, whose IDs jobs.create takes Risk: read
Input Output

Lead Sources

list

leadSources.list List the lead sources, for reporting where a lead came from Risk: read
Input Output

Lead Statuses

list

leadStatuses.list List the lead statuses, whose IDs jobs.list filters by Risk: read
Input Output

Notes

create

notes.create Add an HTML note to a job or a contact Risk: write
Input contentHtml takes HTML, not plain text. Output

delete

notes.delete Permanently delete a note Risk: destructive · Irreversible
Input Output

list

notes.list List notes, optionally only those on one job Risk: read
Input Output

Payments

create

payments.create Record a payment against a job, which changes that job balance Risk: write
Input amount is an integer in the studio currency; status accepts future, confirmed-future, posted, failed or pending and defaults to posted. Output

delete

payments.delete Delete a payment, which removes it from the job balance Risk: destructive · Irreversible
Input Output

get

payments.get Read one payment with its refunded amount and memo Risk: read
Input Output

list

payments.list List payments with their job, amount, status and method Risk: read
Input Output

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
Input Output

Products

create

products.create Add a product to the price list Risk: write
Input price is an integer in the studio currency, so 25000 is 250.00; a decimal is rejected. Output

delete

products.delete Delete a product; orders that already include it keep their line item Risk: destructive · Irreversible
Input Output

get

products.get Read one product with its price, SKU and flags Risk: read
Input Output

list

products.list List the products in your price list Risk: read
Input Output

update

products.update Change a product’s name, price, SKU or flags Risk: write
Input Output

Studio

get

studio.get Read the studio profile, including its currency and timezone Risk: read
Input: empty object Output

Task Lists

list

taskLists.list List the task lists, whose IDs tasks.create takes Risk: read
Input Output

Tasks

create

tasks.create Create a task in a task list, optionally on a job Risk: write
Input name and taskListId are both required; get the list ID from taskLists.list. Output

delete

tasks.delete Permanently delete a task Risk: destructive · Irreversible
Input Output

list

tasks.list List tasks with their list, assignee and due date Risk: read
Input Output

update

tasks.update Change a task’s name, assignee, due date or completed state Risk: write
Input Output