> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# JobNimbus

> JobNimbus is a CRM and project management software designed for contractors, helping streamline scheduling, estimates, invoicing, and job tracking.

![JobNimbus logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/jobnimbus.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=0e79736d8f523402218200992a4c9afc)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 21
* **Triggers:** 0
* **Slug:** `JOBNIMBUS`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Location
>
> **Slug:** `JOBNIMBUS_ACCOUNT_CREATE_LOCATION`
>
> Tool to create a new location in JobNimbus. Use after gathering address and contact details.
>
> #### Input Parameters
>
> **zip** `string`
>
> Postal code for the location
>
> **city** `string`
>
> City of the location
>
> **code** `string`
>
> Short code or abbreviation for the location
>
> **name** `string` *required*
>
> Name of the location
>
> **phone** `string`
>
> Phone number for the location
>
> **is\_active** `boolean`
>
> Whether the location is active
>
> **state\_text** `string`
>
> State or province of the location
>
> **country\_name** `string`
>
> Country of the location
>
> **address\_line1** `string`
>
> First line of the location's address
>
> **address\_line2** `string`
>
> Second line of the location's address
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Settings
>
> **Slug:** `JOBNIMBUS_ACCOUNT_GET_SETTINGS`
>
> Tool to retrieve account-wide settings (workflows, types, sources). Use after authenticating to load or refresh workflow and source mappings.
>
> #### Input Parameters
>
> **actor** `string`
>
> Optional JobNimbus user email to impersonate this request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Activity by ID
>
> **Slug:** `JOBNIMBUS_ACTIVITY_GET`
>
> Retrieves a specific JobNimbus activity by its unique jnid, including available details about the event, its creator, and related records.
>
> #### Input Parameters
>
> **jnid** `string` *required*
>
> The unique JobNimbus ID (jnid) of the activity to retrieve. This is a hexadecimal string identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact by ID
>
> **Slug:** `JOBNIMBUS_CONTACT_GET`
>
> Tool to retrieve a contact by ID. Use after obtaining the contact’s jnid to fetch full details.
>
> #### Input Parameters
>
> **jnid** `string` *required*
>
> The JobNimbus ID (jnid) of the contact to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contacts
>
> **Slug:** `JOBNIMBUS_CONTACT_LIST`
>
> Tool to list all contacts. Use when you need to fetch multiple contacts, e.g., for reporting or synchronization.
>
> #### Input Parameters
>
> **from** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **size** `integer`
>
> Maximum number of contacts to return (>=1). Defaults to 1000.
>
> **fields** `string`
>
> Comma-separated list of contact fields to include. Defaults to all fields.
>
> **filter** `string`
>
> URL-encoded JSON filter for advanced querying.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `JOBNIMBUS_CONTACT_UPDATE`
>
> Tool 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
>
> **zip** `string`
>
> ZIP code of the contact
>
> **city** `string`
>
> City of the contact
>
> **jnid** `string` *required*
>
> Unique JobNimbus identifier of the contact to update
>
> **tags** `array`
>
> Tags associated with the contact
>
> **email** `string`
>
> Email address of the contact
>
> **company** `string`
>
> Company name associated with the contact
>
> **website** `string`
>
> Website URL
>
> **lastName** `string`
>
> Last name of the contact
>
> **faxNumber** `string`
>
> Fax number
>
> **firstName** `string`
>
> First name of the contact
>
> **homePhone** `string`
>
> Home phone number
>
> **stateText** `string`
>
> State of the contact
>
> **workPhone** `string`
>
> Work phone number
>
> **externalId** `string`
>
> External identifier
>
> **sourceName** `string`
>
> Source from which the contact originated
>
> **statusName** `string`
>
> Status of the contact
>
> **contactType** `string`
>
> Type/category of the contact (record type name)
>
> **description** `string`
>
> Internal notes or description
>
> **displayName** `string`
>
> Display name of the contact
>
> **mobilePhone** `string`
>
> Mobile phone number
>
> **addressLine1** `string`
>
> Address line 1
>
> **addressLine2** `string`
>
> Address line 2
>
> **salesRepName** `string`
>
> Name of the sales representative
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create File Attachment Type
>
> **Slug:** `JOBNIMBUS_CREATE_FILE_TYPE`
>
> Creates 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
>
> **IsActive** `boolean`
>
> Whether the file type should be active and available for use immediately. Defaults to True.
>
> **TypeName** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Material Order
>
> **Slug:** `JOBNIMBUS_CREATE_MATERIAL_ORDER`
>
> Creates 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
>
> **items** `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.
>
> **notes** `string`
>
> Optional notes or comments about the order.
>
> **number** `string`
>
> Optional material order number.
>
> **status** `integer`
>
> Numeric status code of the material order (0-7). Use 0 for Draft.
>
> **related** `array` *required*
>
> List of related jobs or contacts (at least one required). Material orders must be linked to a job or contact record.
>
> **vendorId** `integer`
>
> Identifier of the vendor for this order.
>
> **assignedToId** `integer`
>
> User ID to whom this order is assigned.
>
> **expectedDate** `string`
>
> Expected delivery date in ISO 8601 format (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Task
>
> **Slug:** `JOBNIMBUS_CREATE_TASK`
>
> Tool to create a new task. Use when scheduling or tracking tasks linked to contacts or jobs.
>
> #### Input Parameters
>
> **title** `string` *required*
>
> Title of the task.
>
> **related** `array`
>
> List of related records (contacts or jobs) to attach this task to.
>
> **date\_end** `integer`
>
> End date as a Unix timestamp (seconds since epoch). Use 0 or omit for open-ended tasks.
>
> **date\_start** `integer` *required*
>
> Start date as a Unix timestamp (seconds since epoch).
>
> **record\_type** `integer`
>
> Numeric identifier of the task type.
>
> **record\_type\_name** `string` *required*
>
> Name of the task type as defined in account settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Workflow Status
>
> **Slug:** `JOBNIMBUS_CREATE_WORKFLOW_STATUS`
>
> Tool 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
>
> **name** `string` *required*
>
> Display name of the new status
>
> **is\_lead** `boolean`
>
> Whether this status marks a lead
>
> **is\_active** `boolean`
>
> Whether the status is active
>
> **is\_closed** `boolean`
>
> Whether this status marks closure
>
> **workflowid** `string` *required*
>
> ID of the target workflow (obtained from JOBNIMBUS\_ACCOUNT\_GET\_SETTINGS)
>
> **is\_archived** `boolean`
>
> Whether this status should be archived
>
> **force\_mobile\_sync** `boolean`
>
> Whether to force mobile sync on status change
>
> **send\_to\_quickbooks** `boolean`
>
> Whether to sync this status to QuickBooks
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File Attachment Content by ID
>
> **Slug:** `JOBNIMBUS_FILE_GET`
>
> Retrieves 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
>
> **jnid** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Activities
>
> **Slug:** `JOBNIMBUS_LIST_ACTIVITIES`
>
> Tool to retrieve all activities. Use after authentication to fetch a paginated list of activities.
>
> #### Input Parameters
>
> **size** `integer`
>
> Maximum number of activities to return (>=1). Defaults to 1000.
>
> **filter** `string`
>
> URL-encoded JSON filter for advanced querying.
>
> **offset** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `JOBNIMBUS_LIST_INVOICES`
>
> Tool to list all invoices (v2). Use when you need to fetch multiple invoice records.
>
> #### Input Parameters
>
> **from** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **size** `integer`
>
> Maximum number of invoices to return (>=1). Defaults to 1000.
>
> **fields** `string`
>
> Comma-separated list of invoice fields to include. Defaults to all fields.
>
> **filter** `string`
>
> JSON filter for advanced querying (e.g., filter by status\_name, customer, etc.). Note: May require proper URL encoding depending on API implementation.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Material Orders
>
> **Slug:** `JOBNIMBUS_LIST_MATERIAL_ORDERS`
>
> Tool to list all material orders (v2). Use after authentication to fetch multiple material order records.
>
> #### Input Parameters
>
> **from** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **size** `integer`
>
> Maximum number of material orders to return (>=1). Defaults to 1000.
>
> **fields** `string`
>
> Comma-separated list of material order fields to include. Defaults to all fields.
>
> **filter** `string`
>
> URL-encoded JSON filter for advanced querying.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `JOBNIMBUS_LIST_PAYMENTS`
>
> Tool to retrieve payments list with optional filters. Use after auth.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>=1). Defaults to 1.
>
> **jobId** `integer`
>
> Filter payments by associated job ID.
>
> **dateTo** `string`
>
> End date (YYYY-MM-DD) filter.
>
> **perPage** `integer`
>
> Number of payments per page (>=1). Defaults to 100.
>
> **dateFrom** `string`
>
> Start date (YYYY-MM-DD) filter.
>
> **contactId** `integer`
>
> Filter payments by associated contact ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `JOBNIMBUS_LIST_PRODUCTS`
>
> Lists 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
>
> **from** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **size** `integer`
>
> Maximum number of products to return (>=1). Defaults to 1000.
>
> **fields** `string`
>
> Comma-separated list of product fields to include. Defaults to all fields.
>
> **filter** `string`
>
> URL-encoded JSON filter for advanced querying.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Work Orders
>
> **Slug:** `JOBNIMBUS_LIST_WORKORDERS`
>
> Tool to retrieve all work orders (v2). Use after authentication when you need a paginated list of work orders.
>
> #### Input Parameters
>
> **from** `integer`
>
> Zero-based offset for pagination. Defaults to 0.
>
> **size** `integer`
>
> Maximum number of work orders to return (>=1). Defaults to 1000.
>
> **fields** `string`
>
> Comma-separated list of work order fields to include. Defaults to all fields.
>
> **filter** `string`
>
> URL-encoded JSON filter for advanced querying.
>
> **sort\_field** `string`
>
> Field to sort results by. Defaults to 'date\_created'.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort order: 'asc' or 'desc'. Defaults to 'desc'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Product by ID
>
> **Slug:** `JOBNIMBUS_PRODUCT_GET`
>
> Retrieves 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
>
> **jnid** `string` *required*
>
> The JobNimbus product ID (jnid) to retrieve. A 22-character alphanumeric identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tasks
>
> **Slug:** `JOBNIMBUS_TASK_LIST`
>
> List JobNimbus tasks for planning or review, with optional pagination and filters. Each call returns one response rather than automatically collecting every page.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results (1-indexed).
>
> **status** `string`
>
> Filter tasks by status.
>
> **due\_date** `string`
>
> Filter by due date in YYYY-MM-DD format.
>
> **per\_page** `integer`
>
> Number of results per page.
>
> **assigned\_to** `integer`
>
> Filter by assigned user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Task
>
> **Slug:** `JOBNIMBUS_UPDATE_TASK`
>
> Update 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
>
> **jnid** `string` *required*
>
> JobNimbus ID (jnid) of the task to update. Obtain from List Tasks or Create Task actions.
>
> **title** `string`
>
> New title for the task
>
> **date\_end** `integer`
>
> New end timestamp in Unix epoch seconds
>
> **priority** `integer`
>
> Task priority: 0=none, 1=high, 2=medium, 3=low
>
> **date\_start** `integer`
>
> New start timestamp in Unix epoch seconds
>
> **description** `string`
>
> New description or notes for the task
>
> **record\_type** `integer`
>
> Task type ID. Must be provided with record\_type\_name if updating task type.
>
> **record\_type\_name** `string`
>
> Task type name. Must be provided with record\_type if updating task type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Units of Measure
>
> **Slug:** `JOBNIMBUS_UTILITY_GET_UOMS`
>
> Tool to retrieve list of supported units of measure. Use after authenticating when you need to present or validate measurement units.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
