Jobnimbus | Composio Docs

Overview

SLUG: JOBNIMBUS

Description

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

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Jobnimbus

Create an auth config

Use the dashboard to create an auth config for the Jobnimbus toolkit. This allows you to connect multiple Jobnimbus accounts to Composio for agents to use.

Select App

Navigate to Jobnimbus.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Jobnimbus Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 jobnimbus_auth_config_id = "ac_YOUR_JOBNIMBUS_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Jobnimbus for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, jobnimbus_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Jobnimbus toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

JOBNIMBUS_ACCOUNT_CREATE_LOCATION

Tool Name: Create Location

Description

Tool to create a new location in JobNimbus. Use after gathering address and contact details.

Action Parameters

address_line1

address_line2

city

code

country_name

is_active

Defaults to True

name

stringRequired

phone

state_text

zip

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_ACCOUNT_GET_SETTINGS

Tool Name: Get Account Settings

Description

Tool to retrieve account-wide settings (workflows, types, sources). Use after authenticating to load or refresh workflow and source mappings.

Action Parameters

actor

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_ACTIVITY_GET

Tool Name: Get Activity by ID

Description

Tool to retrieve a specific activity by its ID. Use after confirming the activity's jnid is valid.

Action Parameters

jnid

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CONTACT_GET

Tool Name: Get Contact by ID

Description

Tool to retrieve a contact by ID. Use after obtaining the contact’s jnid to fetch full details.

Action Parameters

jnid

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CONTACT_LIST

Tool Name: List Contacts

Description

Tool to list all contacts. Use when you need to fetch multiple contacts, e.g., for reporting or synchronization.

Action Parameters

fields

filter

from

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CONTACT_UPDATE

Tool Name: Update Contact

Description

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.

Action Parameters

addressLine1

addressLine2

city

company

contactType

description

displayName

externalId

faxNumber

firstName

homePhone

jnid

stringRequired

lastName

mobilePhone

salesRepName

sourceName

stateText

statusName

JOBNIMBUS_CREATE_FILE_TYPE

Tool Name: Create File Attachment Type

Description

Tool to create a new file attachment type. Use when you need to register a custom document category before uploading files.

Action Parameters

IsActive

TypeName

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CREATE_MATERIAL_ORDER

Tool Name: Create Material Order

Description

Tool to create a new material order (v2). Use when you need to place a materials order for a contact after gathering item details.

Action Parameters

assignedToId

contactId

integerRequired

expectedDate

materialOrderItems

notes

number

status

vendorId

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CREATE_TASK

Tool Name: Create Task

Description

Tool to create a new task. Use when scheduling or tracking tasks linked to contacts or jobs.

Action Parameters

date_end

date_start

integerRequired

record_type

record_type_name

stringRequired

title

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_CREATE_WORKFLOW_STATUS

Tool Name: Create Workflow Status

Description

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'.

Action Parameters

force_mobile_sync

boolean

is_active

booleanDefaults to True

is_archived

boolean

is_closed

boolean

is_lead

boolean

name

stringRequired

send_to_quickbooks

boolean

workflowid

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_FILE_GET

Tool Name: Get File Attachment by ID

Description

Tool to retrieve a specific file attachment's raw content by ID.

Action Parameters

jnid

stringRequired

Action Response

data

stringRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_ACTIVITIES

Tool Name: List Activities

Description

Tool to retrieve all activities. Use after authentication to fetch a paginated list of activities.

Action Parameters

fields

filter

offset

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_INVOICES

Tool Name: List Invoices

Description

Tool to list all invoices (v2). Use when you need to fetch multiple invoice records.

Action Parameters

fields

filter

from

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_MATERIAL_ORDERS

Tool Name: List Material Orders

Description

Tool to list all material orders (v2). Use after authentication to fetch multiple material order records.

Action Parameters

fields

filter

from

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_PAYMENTS

Tool Name: List Payments

Description

Tool to retrieve payments list with optional filters. Use after auth.

Action Parameters

contactId

dateFrom

dateTo

jobId

page

Defaults to 1

perPage

Defaults to 100

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_PRODUCTS

Tool Name: List Products

Description

Tool to list all products. Use after authentication to fetch full product catalog.

Action Parameters

fields

filter

from

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_LIST_WORKORDERS

Tool Name: List Work Orders

Description

Tool to retrieve all work orders (v2). Use after authentication when you need a paginated list of work orders.

Action Parameters

fields

filter

from

size

Defaults to 1000

sort_direction

Defaults to desc

sort_field

Defaults to date_created

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_PRODUCT_GET

Tool Name: Get Product by ID

Description

Tool to retrieve a specific product by ID (v2). Use after confirming the product's jnid to fetch its details.

Action Parameters

jnid

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_TASK_LIST

Tool Name: List Tasks

Description

Tool to list all tasks. Use when you need an overview of tasks for planning or review.

Action Parameters

assigned_to

due_date

page

per_page

status

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_UPDATE_TASK

Tool Name: Update Task

Description

Tool to update an existing task. Use after confirming the task’s jnid and desired changes.

Action Parameters

date_end

date_start

description

is_completed

jnid

stringRequired

priority

record_type

record_type_name

title

Action Response

data

objectRequired

error

successful

booleanRequired

JOBNIMBUS_UTILITY_GET_UOMS

Tool Name: Get Units of Measure

Description

Tool to retrieve list of supported units of measure. Use after authenticating when you need to present or validate measurement units.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired