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

Tools

Create Location

SLUG: JOBNIMBUS_ACCOUNT_CREATE_LOCATION

Tool to create a new location in jobnimbus. use after gathering address and contact details.

Action Parameters

address_line1

string

address_line2

string

city

string

code

string

country_name

string

is_active

booleanDefaults to True

name

stringRequired

phone

string

state_text

string

zip

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Activity by ID

SLUG: JOBNIMBUS_ACTIVITY_GET

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

string

successful

booleanRequired

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.

Action Parameters

jnid

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

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.

Action Parameters

fields

string

filter

string

from

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create File Attachment Type

SLUG: JOBNIMBUS_CREATE_FILE_TYPE

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

Action Parameters

IsActive

boolean

TypeName

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Material Order

SLUG: JOBNIMBUS_CREATE_MATERIAL_ORDER

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

integer

contactId

integerRequired

expectedDate

string

materialOrderItems

array

notes

string

number

string

status

string

vendorId

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Task

SLUG: JOBNIMBUS_CREATE_TASK

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

Action Parameters

date_end

integer

date_start

integerRequired

record_type

integer

record_type_name

stringRequired

array

title

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

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

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

string

successful

booleanRequired

Get File Attachment by ID

SLUG: JOBNIMBUS_FILE_GET

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

Action Parameters

jnid

stringRequired

Action Response

data

stringRequired

error

string

successful

booleanRequired

Get Account Settings

SLUG: JOBNIMBUS_JOBNIMBUS_ACCOUNT_GET_SETTINGS

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

Action Parameters

actor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update Contact

SLUG: JOBNIMBUS_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.

Action Parameters

addressLine1

string

addressLine2

string

city

string

company

string

contactType

string

description

string

displayName

string

externalId

string

faxNumber

string

firstName

string

homePhone

string

jnid

stringRequired

lastName

string

mobilePhone

string

salesRepName

string

sourceName

string

stateText

string

statusName

string

List Tasks

SLUG: JOBNIMBUS_JOBNIMBUS_TASK_LIST

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

Action Parameters

assigned_to

integer

due_date

string

page

integer

per_page

integer

status

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Activities

SLUG: JOBNIMBUS_LIST_ACTIVITIES

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

Action Parameters

fields

string

filter

string

offset

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Invoices

SLUG: JOBNIMBUS_LIST_INVOICES

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

Action Parameters

fields

string

filter

string

from

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Material Orders

SLUG: JOBNIMBUS_LIST_MATERIAL_ORDERS

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

Action Parameters

fields

string

filter

string

from

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Payments

SLUG: JOBNIMBUS_LIST_PAYMENTS

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

Action Parameters

contactId

integer

dateFrom

string

dateTo

string

jobId

integer

page

integerDefaults to 1

perPage

integerDefaults to 100

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Products

SLUG: JOBNIMBUS_LIST_PRODUCTS

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

Action Parameters

fields

string

filter

string

from

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

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.

Action Parameters

fields

string

filter

string

from

integer

size

integerDefaults to 1000

sort_direction

stringDefaults to desc

sort_field

stringDefaults to date_created

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Product by ID

SLUG: JOBNIMBUS_PRODUCT_GET

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

string

successful

booleanRequired

Update Task

SLUG: JOBNIMBUS_UPDATE_TASK

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

Action Parameters

date_end

integer

date_start

integer

description

string

is_completed

boolean

jnid

stringRequired

priority

integer

record_type

integer

record_type_name

string

array

title

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired