Introduction

The SecurityTrax API is a REST interface that lets you read and write SecurityTrax data from outside the web UI. Integrators use it to sync customers, manage notes and work orders, query invoices, and power custom tooling.

Every request is a plain HTTPS call with JSON in and JSON out — any language or HTTP client works. The examples in this book use curl.

Base URL

https://portal.securitytrax.com/{profile}/user/v4/

{profile} is your company's SecurityTrax identifier — the same segment you see in your browser when logged in. If your team works at portal.securitytrax.com/acme, your API base URL is:

https://portal.securitytrax.com/acme/user/v4/

v4 is the API version. Breaking changes only ever ship under a new version prefix — v4 requests keep working as-is.

Your first request

Authenticate with a personal access token in the Authorization header (see Authentication for how to create one), then fetch a customer:

curl "https://portal.securitytrax.com/acme/user/v4/customers/1" \
  -H "Authorization: Bearer stx_acme_..."

{
  "ok": true,
  "data": {
    "type": "customers",
    "id": "1",
    "attributes": {
      "fname": "John",
      "lname": "Doe",
      "city": "Draper",
      "state": "UT",
      "...": "..."
    }
  },
  "summary": null,
  "breadcrumbs": [],
  "meta": { "surface": "api" },
  "errors": []
}

Every response — success or failure — uses that same envelope. ok is the one field to branch on; data holds the resource; errors is empty on success. Requests and responses covers the full shape.

Note. The API enforces the same permissions as the SecurityTrax UI. A token acts as the user who created it: it can only read and change what that user can read and change, field by field. Two tokens can receive different fields for the same record.

What you'll find here

Authentication — create a token and make authenticated calls.
Requests and responses — URLs, verbs, the response envelope, errors, pagination, and rate limits.
Resource Reference — per-resource documentation for every available operation, starting with Customers. More resources are added as they're finalized.

Authentication — start here to get a token.
Requests and responses — the conventions every endpoint shares.

Introduction

Base URL

Your first request

What you'll find here

Related