JobNimbus
jobnimbusJobNimbus is a CRM and project management software designed for contractors, helping streamline scheduling, estimates, invoicing, and job tracking.
Acciones disponibles (21)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create LocationJOBNIMBUS_ACCOUNT_CREATE_LOCATIONAcciónTool to create a new location in jobnimbus. use after gathering address and contact details.
JOBNIMBUS_ACCOUNT_CREATE_LOCATIONAcciónTool to create a new location in jobnimbus. use after gathering address and contact details.
Parámetros de entrada
zipstringPostal code for the location
citystringCity of the location
codestringShort code or abbreviation for the location
namestringObligatorioName of the location
phonestringPhone number for the location
is_activebooleanWhether the location is active
state_textstringState or province of the location
country_namestringCountry of the location
address_line1stringFirst line of the location's address
address_line2stringSecond line of the location's address
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Activity by IDJOBNIMBUS_ACTIVITY_GETAcciónTool to retrieve a specific activity by its id. use after confirming the activity's jnid is valid.
JOBNIMBUS_ACTIVITY_GETAcciónTool to retrieve a specific activity by its id. use after confirming the activity's jnid is valid.
Parámetros de entrada
jnidstringObligatorioThe JobNimbus ID (jnid) of the activity to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact by IDJOBNIMBUS_CONTACT_GETAcciónTool to retrieve a contact by id. use after obtaining the contact’s jnid to fetch full details.
JOBNIMBUS_CONTACT_GETAcciónTool to retrieve a contact by id. use after obtaining the contact’s jnid to fetch full details.
Parámetros de entrada
jnidstringObligatorioThe JobNimbus ID (jnid) of the contact to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ContactsJOBNIMBUS_CONTACT_LISTAcciónTool to list all contacts. use when you need to fetch multiple contacts, e.g., for reporting or synchronization.
JOBNIMBUS_CONTACT_LISTAcciónTool to list all contacts. use when you need to fetch multiple contacts, e.g., for reporting or synchronization.
Parámetros de entrada
fromintegerZero-based offset for pagination. Defaults to 0.
sizeintegerMaximum number of contacts to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of contact fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create File Attachment TypeJOBNIMBUS_CREATE_FILE_TYPEAcciónTool to create a new file attachment type. use when you need to register a custom document category before uploading files.
JOBNIMBUS_CREATE_FILE_TYPEAcciónTool to create a new file attachment type. use when you need to register a custom document category before uploading files.
Parámetros de entrada
IsActivebooleanWhether the new file type should be active immediately.
TypeNamestringObligatorioName of the new file attachment type.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Material OrderJOBNIMBUS_CREATE_MATERIAL_ORDERAcciónTool to create a new material order (v2). use when you need to place a materials order for a contact after gathering item details.
JOBNIMBUS_CREATE_MATERIAL_ORDERAcciónTool to create a new material order (v2). use when you need to place a materials order for a contact after gathering item details.
Parámetros de entrada
notesstringOptional notes or comments about the order.
numberstringOptional material order number.
statusstringStatus of the material order (e.g., 'Draft', 'Ordered').
vendorIdintegerIdentifier of the vendor for this order.
contactIdintegerObligatorioUnique identifier of the contact to link this order.
assignedToIdintegerUser ID to whom this order is assigned.
expectedDatestringExpected delivery date in ISO 8601 format (YYYY-MM-DD).
materialOrderItemsobject[]List of items to include in this material order.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TaskJOBNIMBUS_CREATE_TASKAcciónTool to create a new task. use when scheduling or tracking tasks linked to contacts or jobs.
JOBNIMBUS_CREATE_TASKAcciónTool to create a new task. use when scheduling or tracking tasks linked to contacts or jobs.
Parámetros de entrada
titlestringObligatorioTitle of the task.
relatedobject[]List of related records (contacts or jobs) to attach this task to.
date_endintegerEnd date as a Unix timestamp (seconds since epoch). Use 0 or omit for open-ended tasks.
date_startintegerObligatorioStart date as a Unix timestamp (seconds since epoch).
record_typeintegerNumeric identifier of the task type.
record_type_namestringObligatorioName of the task type as defined in account settings.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Workflow StatusJOBNIMBUS_CREATE_WORKFLOW_STATUSAcciónTool to create a new status in an existing workflow. use after confirming the workflow id to add specialized status entries like 'lead' or 'inspection'.
JOBNIMBUS_CREATE_WORKFLOW_STATUSAcciónTool to create a new status in an existing workflow. use after confirming the workflow id to add specialized status entries like 'lead' or 'inspection'.
Parámetros de entrada
namestringObligatorioDisplay name of the new status
is_leadbooleanWhether this status marks a lead
is_activebooleanWhether the status is active
is_closedbooleanWhether this status marks closure
workflowidstringObligatorioID of the target workflow
is_archivedbooleanWhether this status should be archived
force_mobile_syncbooleanWhether to force mobile sync on status change
send_to_quickbooksbooleanWhether to sync this status to QuickBooks
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get File Attachment by IDJOBNIMBUS_FILE_GETAcciónTool to retrieve a specific file attachment's raw content by id.
JOBNIMBUS_FILE_GETAcciónTool to retrieve a specific file attachment's raw content by id.
Parámetros de entrada
jnidstringObligatorioThe JobNimbus ID (jnid) of the file to retrieve.
Parámetros de salida
datastringObligatorioRaw file content as text or base64 string.
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Account SettingsJOBNIMBUS_JOBNIMBUS_ACCOUNT_GET_SETTINGSAcciónTool to retrieve account-wide settings (workflows, types, sources). use after authenticating to load or refresh workflow and source mappings.
JOBNIMBUS_JOBNIMBUS_ACCOUNT_GET_SETTINGSAcciónTool to retrieve account-wide settings (workflows, types, sources). use after authenticating to load or refresh workflow and source mappings.
Parámetros de entrada
actorstringOptional JobNimbus user email to impersonate this request
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update ContactJOBNIMBUS_JOBNIMBUS_CONTACT_UPDATEAcciónTool to update an existing contact. use when you have a contact's jnid and need to modify its fields. call after fetching or creating a contact.
JOBNIMBUS_JOBNIMBUS_CONTACT_UPDATEAcciónTool to update an existing contact. use when you have a contact's jnid and need to modify its fields. call after fetching or creating a contact.
Parámetros de entrada
zipstringZIP code of the contact
citystringCity of the contact
jnidstringObligatorioUnique JobNimbus identifier of the contact to update
tagsstring[]Tags associated with the contact
emailstringEmail address of the contact
companystringCompany name associated with the contact
websitestringWebsite URL
lastNamestringLast name of the contact
faxNumberstringFax number
firstNamestringFirst name of the contact
homePhonestringHome phone number
stateTextstringState of the contact
workPhonestringWork phone number
externalIdstringExternal identifier
sourceNamestringSource from which the contact originated
statusNamestringStatus of the contact
contactTypestringType/category of the contact
descriptionstringInternal notes or description
displayNamestringDisplay name of the contact
mobilePhonestringMobile phone number
addressLine1stringAddress line 1
addressLine2stringAddress line 2
salesRepNamestringName of the sales representative
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TasksJOBNIMBUS_JOBNIMBUS_TASK_LISTAcciónTool to list all tasks. use when you need an overview of tasks for planning or review.
JOBNIMBUS_JOBNIMBUS_TASK_LISTAcciónTool to list all tasks. use when you need an overview of tasks for planning or review.
Parámetros de entrada
pageintegerPage number of results (1-indexed).
statusstringFilter tasks by status.
due_datestringFilter by due date in YYYY-MM-DD format.
per_pageintegerNumber of results per page.
assigned_tointegerFilter by assigned user ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ActivitiesJOBNIMBUS_LIST_ACTIVITIESAcciónTool to retrieve all activities. use after authentication to fetch a paginated list of activities.
JOBNIMBUS_LIST_ACTIVITIESAcciónTool to retrieve all activities. use after authentication to fetch a paginated list of activities.
Parámetros de entrada
sizeintegerMaximum number of activities to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of activity fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
offsetintegerZero-based offset for pagination. Defaults to 0.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List InvoicesJOBNIMBUS_LIST_INVOICESAcciónTool to list all invoices (v2). use when you need to fetch multiple invoice records.
JOBNIMBUS_LIST_INVOICESAcciónTool to list all invoices (v2). use when you need to fetch multiple invoice records.
Parámetros de entrada
fromintegerZero-based offset for pagination. Defaults to 0.
sizeintegerMaximum number of invoices to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of invoice fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Material OrdersJOBNIMBUS_LIST_MATERIAL_ORDERSAcciónTool to list all material orders (v2). use after authentication to fetch multiple material order records.
JOBNIMBUS_LIST_MATERIAL_ORDERSAcciónTool to list all material orders (v2). use after authentication to fetch multiple material order records.
Parámetros de entrada
fromintegerZero-based offset for pagination. Defaults to 0.
sizeintegerMaximum number of material orders to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of material order fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PaymentsJOBNIMBUS_LIST_PAYMENTSAcciónTool to retrieve payments list with optional filters. use after auth.
JOBNIMBUS_LIST_PAYMENTSAcciónTool to retrieve payments list with optional filters. use after auth.
Parámetros de entrada
pageintegerPage number for pagination (>=1). Defaults to 1.
jobIdintegerFilter payments by associated job ID.
dateTostringEnd date (YYYY-MM-DD) filter.
perPageintegerNumber of payments per page (>=1). Defaults to 100.
dateFromstringStart date (YYYY-MM-DD) filter.
contactIdintegerFilter payments by associated contact ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProductsJOBNIMBUS_LIST_PRODUCTSAcciónTool to list all products. use after authentication to fetch full product catalog.
JOBNIMBUS_LIST_PRODUCTSAcciónTool to list all products. use after authentication to fetch full product catalog.
Parámetros de entrada
fromintegerZero-based offset for pagination. Defaults to 0.
sizeintegerMaximum number of products to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of product fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Work OrdersJOBNIMBUS_LIST_WORKORDERSAcciónTool to retrieve all work orders (v2). use after authentication when you need a paginated list of work orders.
JOBNIMBUS_LIST_WORKORDERSAcciónTool to retrieve all work orders (v2). use after authentication when you need a paginated list of work orders.
Parámetros de entrada
fromintegerZero-based offset for pagination. Defaults to 0.
sizeintegerMaximum number of work orders to return (>=1). Defaults to 1000.
fieldsstringComma-separated list of work order fields to include. Defaults to all fields.
filterstringURL-encoded JSON filter for advanced querying.
sort_fieldstringField to sort results by. Defaults to 'date_created'.
sort_directionstringenumSort order: 'asc' or 'desc'. Defaults to 'desc'.
ascdesc
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Product by IDJOBNIMBUS_PRODUCT_GETAcciónTool to retrieve a specific product by id (v2). use after confirming the product's jnid to fetch its details.
JOBNIMBUS_PRODUCT_GETAcciónTool to retrieve a specific product by id (v2). use after confirming the product's jnid to fetch its details.
Parámetros de entrada
jnidstringObligatorioThe JobNimbus product ID (jnid) to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update TaskJOBNIMBUS_UPDATE_TASKAcciónTool to update an existing task. use after confirming the task’s jnid and desired changes.
JOBNIMBUS_UPDATE_TASKAcciónTool to update an existing task. use after confirming the task’s jnid and desired changes.
Parámetros de entrada
jnidstringObligatorioJobNimbus ID of the task to update
titlestringTitle of the task
relatedstring[]List of JobNimbus IDs of related records
date_endintegerEnd timestamp of the task (Unix epoch seconds)
priorityintegerPriority of the task (0=none,1=high,2=medium,3=low)
date_startintegerStart timestamp of the task (Unix epoch seconds)
descriptionstringDescription or notes for the task
record_typeintegerID of the task type
is_completedbooleanWhether the task is completed
record_type_namestringName of the task type
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Units of MeasureJOBNIMBUS_UTILITY_GET_UOMSAcciónTool to retrieve list of supported units of measure. use after authenticating when you need to present or validate measurement units.
JOBNIMBUS_UTILITY_GET_UOMSAcciónTool to retrieve list of supported units of measure. use after authenticating when you need to present or validate measurement units.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not