Connecting to JobNimbus

Using API Key Authentication

JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

1. Log in to your JobNimbus account.
2. Navigate to Settings > Integrations > API.
3. Generate or copy your existing API key from this page.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your JobNimbus API key.

Example Connection String

Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';

Available Tables

The JobNimbus API Profile provides access to the following tables:

• AccountUsers: Retrieve user accounts associated with the JobNimbus account including name, email, role, calendar color, login history, and location information.
• Activities: Retrieve activity log records from JobNimbus including notes, status changes, source, privacy settings, and related contact or job references.
• Budgets: Retrieve budget records from JobNimbus including revenue, gross profit, gross margin, status, creation dates, and related owner and record references.
• Contacts: Retrieve contact records from JobNimbus including personal details, address, status, financial summaries, and related metadata.
• Estimates: Retrieve estimate records from JobNimbus including estimate number, status, associated sales rep, creation dates, and related owner and record references.
• Files: Retrieve file attachment records from JobNimbus including file name, size, MIME type, upload date, and related record references.
• Invoices: Retrieve invoice records from JobNimbus including invoice number, status, creation dates, and related record references.
• Jobs: Retrieve job records from JobNimbus including site address, status, financial summaries, parent contact details, and related metadata.
• MaterialOrders: Retrieve material order records from JobNimbus including order number, status, creation dates, and related record references.
• Payments: Retrieve payment records from JobNimbus including payment amount, reference, creation dates, and related record references.
• Products: Retrieve product catalog records from JobNimbus including product name, description, item type, active status, and creation metadata.
• Tasks: Retrieve task records from JobNimbus including title, description, priority, scheduled dates, completion status, and associated contacts or jobs.
• WorkOrders: Retrieve work order records from JobNimbus including order number, status, scheduled dates, financial summaries, and related record references.

Important Notes

• The APIKey must be set in ProfileSettings for all requests.
• Several tables support filtering by JobNimbusId to retrieve a specific record (e.g. Activities, Contacts, Estimates, Invoices, Jobs, MaterialOrders, Products, Tasks, WorkOrders).
• Date range filtering is supported on CreatedDate fields using date_start and date_end parameters where available.
• All date fields use Unix timestamp format internally; the driver converts them to standard datetime values.
• Array fields (e.g. owners, related, costs, commissions) are returned as aggregated strings.

API Documentation

For more information about the JobNimbus API, see the official JobNimbus API documentation.

Usage Examples

AccountUsers:

SELECT * FROM AccountUsers

Activities:

SELECT * FROM Activities

Budgets:

SELECT * FROM Budgets

Contacts:

SELECT * FROM Contacts

Contacts (filter by ID):

SELECT * FROM Contacts WHERE JobNimbusId = 'mnrflrbnqcbiev9p5nyt0ax'

Estimates:

SELECT * FROM Estimates

Files:

SELECT * FROM Files

Invoices:

SELECT * FROM Invoices

Jobs:

SELECT * FROM Jobs

Jobs (filter by status):

SELECT * FROM Jobs WHERE StatusId = 372

MaterialOrders:

SELECT * FROM MaterialOrders

Payments:

SELECT * FROM Payments

Products:

SELECT * FROM Products

Tasks:

SELECT * FROM Tasks

Tasks (filter by date):

SELECT * FROM Tasks WHERE CreatedDate >= '2024-01-01'

WorkOrders:

SELECT * FROM WorkOrders

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your JobNimbus API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT