Lead Companies

Reference for the lead_companies resource. Requests follow the conventions in Requests and Responses; fields you receive and may write are filtered by your user's permissions, so responses can contain a subset of the fields below.

Operations

Not available as a standard REST operation for this resource: create, update, delete — such requests return 402 feature_not_enabled or 403 permission_denied.

How it works

lead_companies is the read-only catalog of Sources — where a customer or lead came from. It is labeled "Source" throughout the SecurityTrax UI; the underlying table and the customer field (lead_company_id) keep the lead_company name. These are the valid lead_company_id values when creating/updating a customer or lead.

Only the id, name, and status are exposed — a Source row also holds integration credentials and routing config, which are never returned here. Gated by the Customer Sale Info permission.

curl "https://portal.securitytrax.com/acme/user/v4/lead_companies?name=Acme" \
  -H "Authorization: Bearer stx_acme_..."

Filter by name; sort by id or name; GET /{id} fetches one. Campaigns under a Source are the Source Campaigns catalog.

Fields

Fields are grouped by the permission that gates them. A group you may not view is absent from responses; a group you may not write is rejected with 422 when sent in a write.

Lead Company

View: Customer Sale Info.

Pagination

The list endpoint uses client-controlled offset pagination: ?page= (1-based) and ?per_page= (default 25, max 100). The response mirrors meta.pagination (page, per_page, total, last_page) and sends an RFC5988 Link header; follow rel="next" to walk pages. See Pagination.

Filters

The list endpoint accepts these query-param filters: name. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

GET .../lead_companies?sort= orders the list by: id, name. Prefix a field with - for descending; comma-separate for tie-breakers. An unsupported field returns 422. See Sorting collections.

Related

• Requests and Responses — envelope, errors, pagination, and rate limits.
• Authentication — tokens and the Authorization header.