Onboardly
Get started

Partner API Create candidates, collect documents and references, retrieve the compliance pack.

Get an API key

Account settings

Read your account’s default for whether a candidate’s survey sends automatically — read-only; change it from the dashboard.

GET/api/v1/churnguard/settings#

Read your account’s defaults for whether a candidate’s survey sends automatically once their compliance process completes, and how often scheduled check-ins repeat.

Headers

X-Api-Keyonb_live_<key_id>_<secret>required
Your issued Partner API key — see Authentication.

Status codes

2002xx
autoSend is false, and cadenceDays is the product default (21 — three weeks), when you have never set either.
4014xx
Missing, malformed, unknown, revoked or expired key. Every authentication failure looks the same — see Authentication.
4034xx
Your account’s plan does not include ChurnGuard.
ChurnGuard is not included in your plan.
4294xx
Per-key or per-account rate limit exceeded. Retry after the Retry-After header.
Too many requests — please try again shortly.
5035xx
The read failed — retry.
Some of this candidate’s records could not be read right now. Try again shortly.

Read-only

This setting is changed on the dashboard (Settings → ChurnGuard), never through this API — an integration key carries no scope, so a key-driven write here could not be restricted to a trusted caller. A candidate’s own PATCH .../churnguard/prefs override, when set, always wins over this account default regardless of how either was changed.

cURL
curl \
  "https://rca-onboardly.com/api/v1/churnguard/settings" \
  -H "X-Api-Key: $ONB_KEY"
200 · Response
{
  "autoSend": true,
  "cadenceDays": 21
}
PreviousSurvey preferencesNextPostman collection