Skip to main content

Overview

Field-service operations, estimates, and work orders in ServiceBridge. Call actions with automationType, action, and params from any workflow node that supports automations.

Authentication

  • ServiceBridge Login action returns a session key used by subsequent requests.

Available Actions

Click any action to jump to its example payload. Accounting Activity-Notes Assets Authentication Branches Companies Contacts Custom-Fields Customers Estimates Inventory Invoices Jobs Leads Locations Marketing Payments Personnel Sales Service-Agreements Service-Plans Statistics Tasks Taxes Teams Terms Users Work-Orders

Examples

Example 1: ServiceBridge - Login to ServiceBridge

Authenticate and obtain a session key

Example 2: ServiceBridge - Logout from ServiceBridge

Invalidate the current session

Example 3: ServiceBridge - List Customers

Get a paginated list of customers

Example 4: ServiceBridge - Get Customer by ID

Retrieve a specific customer

Example 5: ServiceBridge - Create Customer

Create a new customer (lead)

Example 6: ServiceBridge - Update Customer

Update an existing customer (sparse update)

Example 7: ServiceBridge - Delete Customer

Delete a customer

Example 8: ServiceBridge - Activate Customer

Mark a customer as active

Example 9: ServiceBridge - Get Customer Bank Accounts

Get saved bank accounts for a customer

Example 10: ServiceBridge - Get Customer Payment Cards

Get saved payment cards for a customer

Example 11: ServiceBridge - Create Customer Category

Create a new customer category

Example 12: ServiceBridge - List Contacts

Get contacts for a customer

Example 13: ServiceBridge - Get Contact

Get a specific contact

Example 14: ServiceBridge - Create Contact

Create a new contact for a customer

Example 15: ServiceBridge - Update Contact

Update an existing contact

Example 16: ServiceBridge - Delete Contact

Delete a contact

Example 17: ServiceBridge - List Locations

Get a paginated list of service locations

Example 18: ServiceBridge - Get Location

Get a specific location

Example 19: ServiceBridge - List Location Contacts

Get contacts at a location

Example 20: ServiceBridge - Update Location Contact

Update a contact at a location

Example 21: ServiceBridge - Delete Location Contact

Remove a contact from a location

Example 22: ServiceBridge - List Estimates

Get a paginated list of estimates

Example 23: ServiceBridge - Get Estimate

Get a specific estimate

Example 24: ServiceBridge - Create Estimate

Create a new estimate (free inspection)

Example 25: ServiceBridge - Update Estimate

Update an existing estimate

Example 26: ServiceBridge - Delete Estimate

Delete an estimate

Example 27: ServiceBridge - Duplicate Estimate

Create a copy of an estimate

Example 28: ServiceBridge - Win Estimate

Mark estimate as won

Example 29: ServiceBridge - Lose Estimate

Mark estimate as lost

Example 30: ServiceBridge - Reopen Estimate

Reopen a closed estimate

Example 31: ServiceBridge - Get Estimate Documents

List documents for an estimate

Example 32: ServiceBridge - Get Estimate Document

Get a specific document

Example 33: ServiceBridge - Get Estimate Photos

List photos for an estimate

Example 34: ServiceBridge - List Work Orders

Get a paginated list of work orders

Example 35: ServiceBridge - Get Work Order

Get a specific work order

Example 36: ServiceBridge - Create Work Order

Create a new work order (installation job)

Example 37: ServiceBridge - Update Work Order

Update an existing work order

Example 38: ServiceBridge - Delete Work Order

Delete a work order

Example 39: ServiceBridge - Get Work Order Documents

List documents for a work order

Example 40: ServiceBridge - Get Work Order Document

Get a specific document

Example 41: ServiceBridge - Get Work Order Photos

List photos for a work order

Example 42: ServiceBridge - Get Work Order Review

Get the review for a work order

Example 43: ServiceBridge - List Work Order Reviews

Get a list of all work order reviews

Example 44: ServiceBridge - List Teams

Get a list of all teams

Example 45: ServiceBridge - Get Team

Get a specific team

Example 46: ServiceBridge - List Personnel

Get a list of all employees

Example 47: ServiceBridge - Get Personnel

Get a specific employee

Example 48: ServiceBridge - List Inventory

Get a paginated list of inventory items

Example 49: ServiceBridge - Get Inventory Item

Get a specific inventory item

Example 50: ServiceBridge - Delete Inventory Item

Delete an inventory item

Example 51: ServiceBridge - Create Product

Create a new product

Example 52: ServiceBridge - Update Product

Update an existing product

Example 53: ServiceBridge - Create Service Item

Create a new service item

Example 54: ServiceBridge - Update Service Item

Update an existing service item

Example 55: ServiceBridge - List Inventory Groups

Get all inventory groups

Example 56: ServiceBridge - Create Inventory Group

Create a new inventory group

Example 57: ServiceBridge - Update Inventory Group

Update an inventory group

Example 58: ServiceBridge - Delete Inventory Group

Delete an inventory group

Example 59: ServiceBridge - List Charge Types

Get all charge types

Example 60: ServiceBridge - Create Charge Type

Create a new charge type

Example 61: ServiceBridge - Update Charge Type

Update a charge type

Example 62: ServiceBridge - Delete Charge Type

Delete a charge type

Example 63: ServiceBridge - List Units

Get all measurement units

Example 64: ServiceBridge - Create Unit

Create a new measurement unit

Example 65: ServiceBridge - Update Unit

Update a measurement unit

Example 66: ServiceBridge - Delete Unit

Delete a measurement unit

Example 67: ServiceBridge - List Invoices

Get a paginated list of invoices

Example 68: ServiceBridge - Get Invoice

Get a specific invoice

Example 69: ServiceBridge - List Payments

Get a paginated list of payments

Example 70: ServiceBridge - Get Payment

Get a specific payment

Example 71: ServiceBridge - Create Payment

Record a new payment

Example 72: ServiceBridge - Update Payment

Update a payment record

Example 73: ServiceBridge - Delete Payment

Delete a payment record

Example 74: ServiceBridge - List Payment Methods

Get available payment methods

Example 75: ServiceBridge - List Branches

Get all branches/locations

Example 76: ServiceBridge - Get Branch

Get a specific branch

Example 77: ServiceBridge - Create Branch

Create a new branch

Example 78: ServiceBridge - Update Branch

Update a branch

Example 79: ServiceBridge - Delete Branch

Delete a branch

Example 80: ServiceBridge - List Companies

Get all companies in hierarchy

Example 81: ServiceBridge - Get Company

Get company details

Example 82: ServiceBridge - List Marketing Campaigns

Get all marketing campaigns

Example 83: ServiceBridge - Get Marketing Campaign

Get a specific campaign

Example 84: ServiceBridge - Create Marketing Campaign

Create a new campaign

Example 85: ServiceBridge - Update Marketing Campaign

Update a campaign

Example 86: ServiceBridge - Delete Marketing Campaign

Delete a campaign

Example 87: ServiceBridge - Get Active Campaigns

Get currently active campaigns

Example 88: ServiceBridge - List Marketing Categories

Get all marketing categories

Example 89: ServiceBridge - Get Marketing Category

Get a specific category

Example 90: ServiceBridge - Create Marketing Category

Create a new category

Example 91: ServiceBridge - Update Marketing Category

Update a category

Example 92: ServiceBridge - Delete Marketing Category

Delete a category

Example 93: ServiceBridge - List Job Categories

Get all job categories

Example 94: ServiceBridge - Get Job Category

Get a specific job category

Example 95: ServiceBridge - Create Job Category

Create a new job category

Example 96: ServiceBridge - Update Job Category

Update a job category

Example 97: ServiceBridge - Delete Job Category

Delete a job category

Example 98: ServiceBridge - List Job Templates

Get all job templates

Example 99: ServiceBridge - Get Job Template

Get a specific job template

Example 100: ServiceBridge - List Leads

Get a paginated list of leads

Example 101: ServiceBridge - Get Lead

Get a specific lead

Example 102: ServiceBridge - Create Lead

Create a new lead

Example 103: ServiceBridge - List Service Agreements

Get all service agreements

Example 104: ServiceBridge - Get Service Agreement

Get a specific agreement

Example 105: ServiceBridge - Create Service Agreement

Create a new agreement

Example 106: ServiceBridge - Update Service Agreement

Update an agreement

Example 107: ServiceBridge - Delete Service Agreement

Delete an agreement

Example 108: ServiceBridge - List Service Plans

Get all service plans

Example 109: ServiceBridge - Get Service Plan

Get a specific plan

Example 110: ServiceBridge - Create Service Plan

Create a new plan

Example 111: ServiceBridge - Update Service Plan

Update a plan

Example 112: ServiceBridge - Delete Service Plan

Delete a plan

Example 113: ServiceBridge - List Tasks

Get a paginated list of tasks

Example 114: ServiceBridge - Get Task

Get a specific task

Example 115: ServiceBridge - Create Task

Create a new task

Example 116: ServiceBridge - Update Task

Update a task

Example 117: ServiceBridge - List Activity Notes

Get notes for an entity

Example 118: ServiceBridge - Get Activity Note

Get a specific note

Example 119: ServiceBridge - Create Activity Note

Create a new note

Example 120: ServiceBridge - Update Activity Note

Update a note

Example 121: ServiceBridge - Delete Activity Note

Delete a note

Example 122: ServiceBridge - List Custom Fields

Get custom fields by entity type (required: Job, Customer, Part, Personnel, Task, JobPart, Equipment, Companies, Location)

Example 123: ServiceBridge - Get Custom Field

Get a specific custom field

Example 124: ServiceBridge - Create Custom Field

Create a new custom field

Example 125: ServiceBridge - Update Custom Field

Update a custom field

Example 126: ServiceBridge - Delete Custom Field

Delete a custom field

Example 127: ServiceBridge - List Custom Field Groups

Get custom field groups by entity type (required: Job, Customer, Part, Personnel, Task, JobPart, Equipment, Companies, Location)

Example 128: ServiceBridge - Get Custom Field Group

Get a specific group

Example 129: ServiceBridge - Create Custom Field Group

Create a new group

Example 130: ServiceBridge - Update Custom Field Group

Update a group

Example 131: ServiceBridge - Delete Custom Field Group

Delete a group

Example 132: ServiceBridge - List Assets

Get a paginated list of assets

Example 133: ServiceBridge - List Accounting Accounts

Get all accounting accounts

Example 134: ServiceBridge - List Sales Representatives

Get all sales reps

Example 135: ServiceBridge - List Taxes

Get all tax configurations

Example 136: ServiceBridge - List Terms

Get all payment terms

Example 137: ServiceBridge - Get Company Statistics

Get company-wide statistics

Example 138: ServiceBridge - Get Invoice Statistics

Get invoice-related statistics

Example 139: ServiceBridge - Get Job Statistics

Get job-related statistics

Example 140: ServiceBridge - Get Payment Statistics

Get payment-related statistics

Example 141: ServiceBridge - Get Report

Generate a report

Example 142: ServiceBridge - Get Active Users History

Get user activity history

Third-Party Documentation