Skip to main content
GET
Get the Pendo config

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Response

200 - application/json

Successful Response

The Pendo settings. The queries are their own resource (/queries).

account_id_field
string | null
required

The Pendo account field that holds the CRM account ID, for example salesforce.accountid. A query reads it with the token {PENDO_ACCOUNT_ID_FIELD}. null until an admin sets it. Find it with /account-fields: a high filled count marks a likely field; check its values with /preview before saving it

surveys
PendoSavedSurveySettings · object | null
required

The NPS survey job's settings. null when never saved: the job then uses the defaults. With no saved Pendo config at all (version 0), the job reads nothing

version
integer
required

The config's version: send it as expected_version with a change (0 = never saved)

week_start_day
integer
required

The day product usage weeks start on: 0 = Monday … 6 = Sunday