Skip to main content
GET
Get a rules-of-engagement policy
One policy with its rules and outcome rules, and whether it is the team default.

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

24-character policy id.

Response

Success.

A rules-of-engagement policy.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

name
string
description
string | null
is_default
boolean

Applied to any sequence that does not name its own.

crm_refresh_hours
integer
rules
object[]
outcome_rules
object[]