Question sets

Discover a question_set_id to pin for a candidate.

GET/api/v1/churnguard/question-sets#

List your own candidate-survey question sets, to choose a question_set_id for the prefs endpoint below.

Headers

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

Status codes

2002xx: Every question set you own, newest-updated first — [] when you have none yet.
4014xx: Missing, malformed, unknown or revoked 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 list read failed — retry.
Some of this candidate’s records could not be read right now. Try again shortly.

Creating, editing or deleting a question set is not exposed over the API — author sets from the dashboard’s Settings page, then pin one here.

cURL

curl \
  "https://rca-onboardly.com/api/v1/churnguard/question-sets" \
  -H "X-Api-Key: $ONB_KEY"

200 · Response

{
  "sets": [
    {
      "id": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
      "name": "Onboarding experience",
      "isDefault": true,
      "questionCount": 8
    }
  ]
}

PreviousOverview NextSend a survey question

GET /api/v1/churnguard/question-sets

cURL

curl \
  "https://rca-onboardly.com/api/v1/churnguard/question-sets" \
  -H "X-Api-Key: $ONB_KEY"

200 · Response

{
  "sets": [
    {
      "id": "4e8c2b1a-9f3d-4c6e-8a1b-2c5d9e4f7a30",
      "name": "Onboarding experience",
      "isDefault": true,
      "questionCount": 8
    }
  ]
}