{
id: string,
type?: string,
name?: string,
number?: string
}
New to Corsair? See API access, authentication, and error handling.
Account
createActivityType
account.createActivityType
Create an activity type in JobNimbus
Risk: write
Output
createCustomField
account.createCustomField
Create a custom field in JobNimbus
Risk: write
Output
createFileType
account.createFileType
Create a file attachment type in JobNimbus
Risk: write
Output
createLeadSource
account.createLeadSource
Create a lead source in JobNimbus
Risk: write
Output
createLocation
account.createLocation
Create a company location in JobNimbus
Risk: write
Output
createTaskType
account.createTaskType
Create a task type in JobNimbus
Risk: write
Output
createWorkflow
account.createWorkflow
Create a workflow in JobNimbus
Risk: write
Output
createWorkflowStatus
account.createWorkflowStatus
Create a status within a workflow in JobNimbus
Risk: write
Output
getGroups
account.getGroups
Retrieve group configuration in JobNimbus
Risk: read
object[]
Output full type
Output full type
getSettings
account.getSettings
Retrieve account settings configuration in JobNimbus
Risk: read
Output:
object \| any[]
Output full type
Output full type
getUoms
account.getUoms
Retrieve units of measurement in JobNimbus
Risk: read
string[]
getUsers
account.getUsers
Retrieve users and team members in JobNimbus
Risk: read
users full type
users full type
Activities
create
activities.create
Create a new activity note in JobNimbus
Risk: write
primary full type
primary full type
get
activities.get
Retrieve an activity by ID in JobNimbus
Risk: read
Output
list
activities.list
Retrieve all activities in JobNimbus
Risk: read
Output
results full type
results full type
Budgets
list
budgets.list
Retrieve all budgets in JobNimbus
Risk: read
Output
results full type
results full type
Contacts
create
contacts.create
Create a new contact in JobNimbus
Risk: write
geo full type
geo full type
owners full type
owners full type
delete
contacts.delete
Delete (deactivate) a contact in JobNimbus
Risk: destructive
Output
get
contacts.get
Retrieve a contact by ID in JobNimbus
Risk: read
Output
list
contacts.list
Retrieve all contacts in JobNimbus
Risk: read
Output
results full type
results full type
update
contacts.update
Update an existing contact in JobNimbus
Risk: write
geo full type
geo full type
owners full type
owners full type
Estimates
create
estimates.create
Create a new estimate in JobNimbus
Risk: write
delete
estimates.delete
Delete (deactivate) an estimate in JobNimbus
Risk: destructive
Output
get
estimates.get
Retrieve an estimate by ID in JobNimbus
Risk: read
Output
list
estimates.list
Retrieve all estimates in JobNimbus
Risk: read
Output
results full type
results full type
update
estimates.update
Update an existing estimate in JobNimbus
Risk: write
Files
abortMultipartUpload
files.abortMultipartUpload
Abort a multipart file upload in JobNimbus
Risk: destructive
Output
completeMultipartUpload
files.completeMultipartUpload
Complete a multipart file upload in JobNimbus
Risk: write
parts full type
parts full type
data full type
data full type
completeSinglePartUpload
files.completeSinglePartUpload
Complete a single part file upload in JobNimbus
Risk: write
Output
data full type
data full type
create
files.create
Create a file attachment with base64 data in JobNimbus
Risk: write
Output
files full type
files full type
createFromUrl
files.createFromUrl
Create a file attachment from a URL in JobNimbus
Risk: write
Output
get
files.get
Retrieve a file attachment by ID in JobNimbus
Risk: read
Output
list
files.list
Retrieve list of file attachments in JobNimbus
Risk: read
Output
files full type
files full type
requestMultipartUpload
files.requestMultipartUpload
Request presigned URLs for multipart file upload in JobNimbus
Risk: write
Output
data full type
data full type
requestSinglePartUpload
files.requestSinglePartUpload
Request a presigned URL for single part file upload in JobNimbus
Risk: write
Output
data full type
data full type
Invoices
create
invoices.create
Create a new invoice in JobNimbus
Risk: write
delete
invoices.delete
Delete (deactivate) an invoice in JobNimbus
Risk: destructive
Output
get
invoices.get
Retrieve an invoice by ID in JobNimbus
Risk: read
Output
list
invoices.list
Retrieve all invoices in JobNimbus
Risk: read
Output
results full type
results full type
update
invoices.update
Update an existing invoice in JobNimbus
Risk: write
Jobs
create
jobs.create
Create a new job in JobNimbus
Risk: write
geo full type
geo full type
primary full type
primary full type
owners full type
owners full type
delete
jobs.delete
Delete (deactivate) a job in JobNimbus
Risk: destructive
Output
get
jobs.get
Retrieve a job by ID in JobNimbus
Risk: read
Output
list
jobs.list
Retrieve all jobs in JobNimbus
Risk: read
Output
results full type
results full type
update
jobs.update
Update an existing job in JobNimbus
Risk: write
geo full type
geo full type
primary full type
primary full type
owners full type
owners full type
Material Orders
create
materialOrders.create
Create a new material order in JobNimbus
Risk: write
items full type
items full type
address full type
address full type
delete
materialOrders.delete
Delete (deactivate) a material order in JobNimbus
Risk: destructive
Output
get
materialOrders.get
Retrieve a material order by ID in JobNimbus
Risk: read
Output
list
materialOrders.list
Retrieve all material orders in JobNimbus
Risk: read
Output
results full type
results full type
update
materialOrders.update
Update an existing material order in JobNimbus
Risk: write
items full type
items full type
address full type
address full type
Payments
create
payments.create
Create a payment in JobNimbus
Risk: write
invoices full type
invoices full type
primary full type
primary full type
owners full type
owners full type
list
payments.list
Retrieve all payments in JobNimbus
Risk: read
Output
results full type
results full type
Products
create
products.create
Create a new product in JobNimbus
Risk: write
uoms full type
uoms full type
delete
products.delete
Delete (deactivate) a product in JobNimbus
Risk: destructive
Output
get
products.get
Retrieve a product by ID in JobNimbus
Risk: read
Output
list
products.list
Retrieve all products in JobNimbus
Risk: read
Output
results full type
results full type
update
products.update
Update an existing product in JobNimbus
Risk: write
uoms full type
uoms full type
Tasks
create
tasks.create
Create a new task in JobNimbus
Risk: write
primary full type
primary full type
assigned_to full type
assigned_to full type
delete
tasks.delete
Delete (deactivate) a task in JobNimbus
Risk: destructive
Output
get
tasks.get
Retrieve a task by ID in JobNimbus
Risk: read
Output
list
tasks.list
Retrieve all tasks in JobNimbus
Risk: read
Output
results full type
results full type
update
tasks.update
Update an existing task in JobNimbus
Risk: write
primary full type
primary full type
assigned_to full type
assigned_to full type
Work Orders
create
workOrders.create
Create a new work order in JobNimbus
Risk: write
delete
workOrders.delete
Delete (deactivate) a work order in JobNimbus
Risk: destructive
Output
get
workOrders.get
Retrieve a work order by ID in JobNimbus
Risk: read
Output
list
workOrders.list
Retrieve all work orders in JobNimbus
Risk: read
Output
results full type
results full type
update
workOrders.update
Update an existing work order in JobNimbus
Risk: write