Skip to main content
JobNimbus logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: JOBNIMBUS
  • Version: 20261101_00

Tools

Slug: JOBNIMBUS_ACCOUNT_CREATE_LOCATIONTool to create a new location in JobNimbus. Use after gathering address and contact details.

Input Parameters

string
Postal code for the location
string
City of the location
string
Short code or abbreviation for the location
string
required
Name of the location
string
Phone number for the location
boolean
Whether the location is active
string
State or province of the location
string
Country of the location
string
First line of the location’s address
string
Second line of the location’s address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_ACCOUNT_GET_SETTINGSTool to retrieve account-wide settings (workflows, types, sources). Use after authenticating to load or refresh workflow and source mappings.

Input Parameters

string
Optional JobNimbus user email to impersonate this request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_ACTIVITY_GETRetrieves a specific JobNimbus activity by its unique jnid, including available details about the event, its creator, and related records.

Input Parameters

string
required
The unique JobNimbus ID (jnid) of the activity to retrieve. This is a hexadecimal string identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CONTACT_GETTool to retrieve a contact by ID. Use after obtaining the contact’s jnid to fetch full details.

Input Parameters

string
required
The JobNimbus ID (jnid) of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CONTACT_LISTTool to list all contacts. Use when you need to fetch multiple contacts, e.g., for reporting or synchronization.

Input Parameters

integer
Zero-based offset for pagination. Defaults to 0.
integer
Maximum number of contacts to return (>=1). Defaults to 1000.
string
Comma-separated list of contact fields to include. Defaults to all fields.
string
URL-encoded JSON filter for advanced querying.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CONTACT_UPDATETool 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.

Input Parameters

string
ZIP code of the contact
string
City of the contact
string
required
Unique JobNimbus identifier of the contact to update
array
Tags associated with the contact
string
Email address of the contact
string
Company name associated with the contact
string
Website URL
string
Last name of the contact
string
Fax number
string
First name of the contact
string
Home phone number
string
State of the contact
string
Work phone number
string
External identifier
string
Source from which the contact originated
string
Status of the contact
string
Type/category of the contact (record type name)
string
Internal notes or description
string
Display name of the contact
string
Mobile phone number
string
Address line 1
string
Address line 2
string
Name of the sales representative

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CREATE_FILE_TYPECreates a new file attachment type in JobNimbus. File types are custom categories used to organize and classify document attachments (e.g., contracts, warranties, photos, permits). You must create a file type before you can upload files with that category.

Input Parameters

boolean
Whether the file type should be active and available for use immediately. Defaults to True.
string
required
The name for the new file attachment type (e.g., ‘Contract’, ‘Warranty’, ‘Photo Gallery’). This will be used to categorize files in JobNimbus.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CREATE_MATERIAL_ORDERCreates a new material order in JobNimbus. A material order tracks materials needed for a job and can be submitted to suppliers. Material orders must be linked to a contact or job record and include at least one line item referencing an existing product from your Products & Services catalog. Prerequisites: - At least one contact or job record must exist (use JOBNIMBUS_CONTACT_LIST to find contacts) - Products must exist in your catalog (use JOBNIMBUS_LIST_PRODUCTS to find product IDs) Note: Custom line items are not supported - all items must reference existing products by their jnid.

Input Parameters

array
required
List of items to include in this material order (at least one required). Each item must reference an existing product by its jnid.
string
Optional notes or comments about the order.
string
Optional material order number.
integer
Numeric status code of the material order (0-7). Use 0 for Draft.
List of related jobs or contacts (at least one required). Material orders must be linked to a job or contact record.
integer
Identifier of the vendor for this order.
integer
User ID to whom this order is assigned.
string
Expected delivery date in ISO 8601 format (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CREATE_TASKTool to create a new task. Use when scheduling or tracking tasks linked to contacts or jobs.

Input Parameters

string
required
Title of the task.
List of related records (contacts or jobs) to attach this task to.
integer
End date as a Unix timestamp (seconds since epoch). Use 0 or omit for open-ended tasks.
integer
required
Start date as a Unix timestamp (seconds since epoch).
integer
Numeric identifier of the task type.
string
required
Name of the task type as defined in account settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_CREATE_WORKFLOW_STATUSTool to create a new status in an existing workflow. Use after confirming the workflow ID to add specialized status entries like ‘Lead’ or ‘Inspection’.

Input Parameters

string
required
Display name of the new status
boolean
Whether this status marks a lead
boolean
Whether the status is active
boolean
Whether this status marks closure
string
required
ID of the target workflow (obtained from JOBNIMBUS_ACCOUNT_GET_SETTINGS)
boolean
Whether this status should be archived
boolean
Whether to force mobile sync on status change
boolean
Whether to sync this status to QuickBooks

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_FILE_GETRetrieves a JobNimbus file attachment by its unique ID and returns the response as text. Binary content may not be preserved by text decoding.

Input Parameters

string
required
The unique JobNimbus ID (jnid) of the file attachment to retrieve. This ID can be obtained from file list endpoints or from related record responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_ACTIVITIESTool to retrieve all activities. Use after authentication to fetch a paginated list of activities.

Input Parameters

integer
Maximum number of activities to return (>=1). Defaults to 1000.
string
URL-encoded JSON filter for advanced querying.
integer
Zero-based offset for pagination. Defaults to 0.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_INVOICESTool to list all invoices (v2). Use when you need to fetch multiple invoice records.

Input Parameters

integer
Zero-based offset for pagination. Defaults to 0.
integer
Maximum number of invoices to return (>=1). Defaults to 1000.
string
Comma-separated list of invoice fields to include. Defaults to all fields.
string
JSON filter for advanced querying (e.g., filter by status_name, customer, etc.). Note: May require proper URL encoding depending on API implementation.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_MATERIAL_ORDERSTool to list all material orders (v2). Use after authentication to fetch multiple material order records.

Input Parameters

integer
Zero-based offset for pagination. Defaults to 0.
integer
Maximum number of material orders to return (>=1). Defaults to 1000.
string
Comma-separated list of material order fields to include. Defaults to all fields.
string
URL-encoded JSON filter for advanced querying.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_PAYMENTSTool to retrieve payments list with optional filters. Use after auth.

Input Parameters

integer
Page number for pagination (>=1). Defaults to 1.
integer
Filter payments by associated job ID.
string
End date (YYYY-MM-DD) filter.
integer
Number of payments per page (>=1). Defaults to 100.
string
Start date (YYYY-MM-DD) filter.
integer
Filter payments by associated contact ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_PRODUCTSLists a page of JobNimbus products with optional sorting and filtering. Returns selected product details and a price derived from the first unit of measure.

Input Parameters

integer
Zero-based offset for pagination. Defaults to 0.
integer
Maximum number of products to return (>=1). Defaults to 1000.
string
Comma-separated list of product fields to include. Defaults to all fields.
string
URL-encoded JSON filter for advanced querying.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_LIST_WORKORDERSTool to retrieve all work orders (v2). Use after authentication when you need a paginated list of work orders.

Input Parameters

integer
Zero-based offset for pagination. Defaults to 0.
integer
Maximum number of work orders to return (>=1). Defaults to 1000.
string
Comma-separated list of work order fields to include. Defaults to all fields.
string
URL-encoded JSON filter for advanced querying.
string
Field to sort results by. Defaults to ‘date_created’.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_PRODUCT_GETRetrieves a JobNimbus product by jnid, returning selected details including taxability and pricing, cost, and unit information derived from the first unit of measure.

Input Parameters

string
required
The JobNimbus product ID (jnid) to retrieve. A 22-character alphanumeric identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_TASK_LISTList JobNimbus tasks for planning or review, with optional pagination and filters. Each call returns one response rather than automatically collecting every page.

Input Parameters

integer
Page number of results (1-indexed).
string
Filter tasks by status.
string
Filter by due date in YYYY-MM-DD format.
integer
Number of results per page.
integer
Filter by assigned user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_UPDATE_TASKUpdate an existing JobNimbus task by its jnid. Allows updating task details like title, description, dates, priority, and task type. Use List Tasks action to find task jnids. Note: To update task type, both record_type and record_type_name must be provided together.

Input Parameters

string
required
JobNimbus ID (jnid) of the task to update. Obtain from List Tasks or Create Task actions.
string
New title for the task
integer
New end timestamp in Unix epoch seconds
integer
Task priority: 0=none, 1=high, 2=medium, 3=low
integer
New start timestamp in Unix epoch seconds
string
New description or notes for the task
integer
Task type ID. Must be provided with record_type_name if updating task type.
string
Task type name. Must be provided with record_type if updating task type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: JOBNIMBUS_UTILITY_GET_UOMSTool to retrieve list of supported units of measure. Use after authenticating when you need to present or validate measurement units.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not