Jobnimbus API Integration Profile
Information and guides about integrating with Jobnimbus API
Add Jobnimbus Integration to Your Product- Retrieve ALL Contacts
This request allows you to retrieve all of the contacts within a JobNimbus account.
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
Request Parameters
Request parameters should be passed in the query string
size - number of elements to return (default: 1000)
from - zero based starting point to be used for pagination (default: 0)
sort_field - which field to sort by (default: date_created)
sort_direction = which direction to sort the results (default: 'desc')
fields - limit which fields to include in response (default: all fields will be included)
filter - URL encoded JSON filter object i.e.:
{ "must": [ { "range": { "date_created": { "gte": 1459749600, "lte": 1459835940 } } } ] }
Response:
Example of a partial response:
{ "recid": 1003, "customer": "29a", "type": "contact", "created_by": "29b", "created_by_name": "Sam Burnet", "date_created": 1459789425, "date_updated": 1460051077, "owners": [ { "id": "29b" } ], "location": { "id": 1, "parent_id": null, "name": "Developer Account" }, "first_name": "Bruce", "last_name": "Wayne", "company": "Wayne Enterprises", "description": "Likes to wear costumes...", "email": "[email protected]", "home_phone": "8882223333", "mobile_phone": "", "work_phone": "", "fax_number": "", "address_line1": "123 S. Bat Street", "address_line2": null, "city": "Heber City", "state_text": "UT", "country_name": "United States", "zip": "84032", "website": "www.batman.com", "record_type": 1, "record_type_name": "Customer", "status": 2, "status_name": "Inspection", "source": 1, "source_name": "Referral", "sales_rep": "1m1", "sales_rep_name": "Sam Burnet", "jnid": "1l7", "geo": { "lat": 0, "lon": 0 }, ... } - Create a Contact
This request allows you to create a new contact within JobNimbus.
Notes:
- First Name, Last Name, First & Last Name, Display_Name, or Company Name are required
- record_type_name is required and should be a workflow name defined in the customers JobNimbus contact workflow settings
- status_name is required and should be a status defined within the record_type_name workflow
- source_name is optional but if provided should be set to one of the lead source names defined in the customer's settings
- Also accepts most of the fields listed in the "GET /contacts" response
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Retrieve a Contact
This request allows you to retrieve the information of a specific contact within JobNimbus.
Notes:
Mandatory field(s): jnid
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Update a Contact
This request allows you to update a contact within JobNimbus.
Notes:
Mandatory field(s): jnid
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Retrieve ALL Jobs
This request allows you to retrieve all of the jobs within a JobNimbus account.
Response Codes:
-
HTTP Status 200 = success
-
Anything other status code = failure and will include an error message in the response
Request Parameters
Request parameters should be passed in the query string
size - number of elements to return (default: 1000)
from - zero based starting point to be used for pagination (default: 0)
sort_field - which field to sort by (default: date_created)
sort_direction = which direction to sort the results (default: 'desc')
fields - limit which fields to include in response (default: all fields will be included)
filter - URL encoded JSON filter object i.e.:
{ "must": [ { "range": { "date_created": { "gte": 1459749600, "lte": 1459835940 } } } ] }Response:
Example of a partial response:
{ "count": 117, "results": [ { "recid": 1001, "customer": "3oz", "type": "job", "created_by": "3p0", "created_by_name": "Bot Barton", "date_created": 1472567571, "date_updated": 1472567572, "location": { "id": 1, "parent_id": null }, "owners": [ { "id": "3p0" } ], "is_active": true, "name": "Test job", "number": "1001", "record_type": 5, "record_type_name": "Residential", "status": 19, "status_name": "Lead", "description": null, "sales_rep": "3p0", "sales_rep_name": "Bob Barton", "address_line1": "100 N 52 E", "address_line2": "", "city": "American Fork", "state_text": "UT", "country_name": "United States", "zip": "84003", "jnid": "3pg", "geo": { "lat": 40.387368, "lon": -111.789513 }, ... ] } -
- Create a Job
This request allows you to create a new job within JobNimbus.
Notes:
- name is required
- record_type_name is required and should be a workflow name defined in the customers JobNimbus job workflow settings
- status_name is required and should be a status defined within the record_type_name workflow
- source_name is optional but if provided should be set to one of the lead source names defined in the customer's settings
- Also accepts most of the fields listed in the "GET /Jobs" response
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Retrieve a Job
This request allows you to retrieve the information of a specific job within JobNimbus.
Notes:
Mandatory field(s): jnid
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Update a Job
This request allows you to update a job within JobNimbus.
Notes:
- Mandatory field(s): jnid
- Also see required fields in "POST Create a Job"
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
- Retrieve ALL Tasks
This request allows you to retrieve all of the tasks within a JobNimbus account.
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response
Response: Example of a partial response:
{ "count": 117, "results": [ { "external_id": null, "recid": 1145, "number": "1145", "customer": "jagpt", "type": "task", "created_by": "jagpu", "created_by_name": "Josh Demo", "date_created": 1547742470, "date_updated": 1547742470, "is_active": true, "is_archived": false, "primary": null, "actual_time": 0, "estimated_time": 0, "title": "Custom Task Type", "location": { "id": 1 }, "description": "New custom task type", "record_type": 6, "record_type_name": "Custom Task Type", "priority": 0, "date_start": 1547712000, "date_sort": null, "date_end": 0, "is_completed": false, "hide_from_calendarview": false, "hide_from_tasklist": false, "owners": [ { "id": "jagpu" } ], "subcontractors": [], "related": [ { "id": "ql1a9", "name": "Martin ROBERTS", "number": "1096", "type": "contact" } ], "jnid": "14yspl", "tags": [], "rules": [] }, ] } - Create a Task
This request allows you to create a new task within JobNimbus.
Notes:
- title and date_start are required
- record_type_name is required and should be a task type name defined in the customer's settings.
- related.id should be set to the contact or job that this task is related to.
- Also accepts most of the fields listed in the "GET /tasks" response
Response Codes:
- HTTP Status 200 = success
- Anything other status code = failure and will include an error message in the response