Interactive Services Providers

Reference for the interactive_services_providers 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

Operation	Request
List	`GET /{profile}/user/v4/interactive_services_providers`
Fetch	`GET /{profile}/user/v4/interactive_services_providers/{id}`

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

interactive_services_providers is the read-only catalog of interactive-services accounts (Alarm.com, SecureNet, Alula, AlarmNet) — the valid interactive_services_provider_id values on a customer connection (optional).

These columns exist on the table and are never returned (list or GET /{id}):

Column	Why it is omitted
`config`	Partner credential blob (passwords, client secrets, dealer keys).
`credentials_valid`	Health of those secrets — not needed to pick an id.
`credentials_last_checked`	Same.

Writes stay off this resource. Configure a provider in SecurityTrax administration.

Visible to any caller holding Customers or Leads.

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

Filters: name (matches anywhere), interactive_services_provider_type_id (exact), active (true / false / all; default true). Sort by id, name, or interactive_services_provider_type_id; GET /{id} fetches one, including an off provider. Soft-deleted rows return 404 by id and are omitted from the list.

Note. The list matches the in-app picker: on providers only unless you pass ?active=false or ?active=all. See Filtering collections.

Provider types

Each row carries an interactive_services_provider_type_id. These ids come from a platform-wide lookup and are identical for every company:

`interactive_services_provider_type_id`	Provider
1	Alarm.com
2	SecureNet
3	Alula
4	AlarmNet

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.

Interactive Services Provider

View: any of: Customer; Lead.

Field	Type	Writable	Validation
`name`	string (nullable)	Read-only	max length 255
`interactive_services_provider_type_id`	integer (nullable)	Read-only	min 0
`active`	boolean (nullable)	Read-only	—
`status`	string (nullable)	Read-only	one of: `active`, `deleted`

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, interactive_services_provider_type_id, active. An unsupported filter parameter returns 422. See Filtering collections for matching semantics.

Sorting

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

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