Skip to main content
GET
Get a rules-of-engagement policy
One policy with its scenarios (rules) and reactions (outcome_rules).

Good to know

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character policy id.

Response

The policy.

A rules-of-engagement policy.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

team
string

Team id.

name
string

Unique on the team.

description
string | null
is_default
boolean

The policy every sequence that names none of its own runs under. Exactly one per team.

crm_refresh_hours
integer

How old a contact's stored CRM data may be, in hours, before a CRM-backed rule refreshes it.

rules
object[]

Scenarios, in evaluation order.

outcome_rules
object[]

Reactions.

sequence_count
integer

Only on GET /v2/sequencer/policies: sequences running under this policy. The default also counts every sequence that names no policy.

created_by
string

Who created it. Absent on the default policy the team started with.

updated_by
string

Who changed it last.

created_at
string<date-time>
updated_at
string<date-time>