We're excited to introduce API v4, a new generation of the SecurityTrax API. v4 is a modern JSON REST API served at /{profile}/user/v4/, with bearer-token authentication and permission-aware responses — the fields you can read and write always reflect your API user's permissions, the same rules enforced in the SecurityTrax app.
Full reference documentation is now published in the API docs book.
Customers & Leads
- Customers — full create, read, update, and delete on customers and leads, including list filtering, sorting (
?sort=), offset pagination (page / per_page), related-record includes (notes, equipment, invoices), and count_only for fast counts.
- Notes, tickets & work orders — create and manage customer notes via
customer_notes, with filters by customer, type, and record type, plus ticket and work-order includes.
- Contacts — full CRUD on
customer_contacts, matching the fields available in the app.
- Tags — attach and detach customer tags via
object_tags; tag name, color, and description are returned inline on reads.
- Custom fields — set and clear customer custom-field (UDF) values via
object_udfs.
Scheduling
- Appointments — list, schedule, reschedule, and cancel technician appointments, and create and manage sales appointments, via
calendar_events.
- Confirmations — record and manage appointment confirmations via
calendar_event_confirmations, with supporting catalogs for confirmation statuses and types.
- Event detail types — full CRUD on
calendar_event_detail_types, plus a read-only calendar_event_types catalog.
Equipment
- Customer equipment — full CRUD and list on
customer_equipment (cost and external-connection fields are read-only).
- Work-order equipment — set and clear the equipment items attached to a work order via
work_order_to_equipment.
Billing
- Billing profiles — full CRUD on
customer_billing, including payment methods. Card and bank numbers are always masked on read.
- Invoices — full CRUD and list on
customer_invoices and invoice_line_items, and one-call recurring-invoice setup via invoice_recurring (header and line items in a single request).
- Payments — full CRUD on
customer_payments, plus dedicated process, void, and refund actions.
Payables
- Payables — manage
customer_payables, their line items, and payments against them, plus a generate action to generate payables on demand.
Funding
- Fundings — full CRUD on
fundings and funding_transactions.
Administration
- Users — create and manage users, including a
reset_password action, rep numbers via user_rep_numbers, and permission assignment via user_to_group_location.
- Groups & locations — full CRUD on
groups and locations, with the sans as the app.
Catalogs
Read-only lookup resources for the IDs you reference elsewhere: account classrs, Sources and Source Campaigns, lead dispositions, lead types, MMR rates, monitoring companies, monitoring plans, terms, and warranties.
