ChurnZero REST API

Name: ChurnZero REST API
Brand: ChurnZero REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCRMCustomer Successbasic22 EndpointsREST

For Agents

Read customer success data from ChurnZero — accounts, contacts, events, churn scores, surveys, tasks, and journey progress.

Install Jentic One Beta

Connect the ChurnZero REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ChurnZero REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with ChurnZero REST API.

Retrieve customer accounts and their churn scores via /Account and /Account({Id})/PrimaryChurnScore

Pull contact records and resolve them to parent accounts via /Contact endpoints

List product usage events and event types through /Event and /EventType

GET STARTED

Start building with ChurnZero REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for ChurnZero REST API, keeping it validated and agent-ready. ChurnZero is a customer success platform that consolidates account health, product usage events, churn scores, and customer journeys into one workspace for CSM teams. The REST API provides read-only access to that data using OData query conventions, so external systems can pull account records, contacts, events, segments, tasks, surveys, churn scores, and journey progress for reporting, BI, and CRM sync. It is the standard integration surface for piping ChurnZero signals into data warehouses and revenue dashboards.

Use Cases

Patterns agents use ChurnZero REST API for, with concrete tasks.

★ Churn Score Sync to CRM

Revenue teams want churn risk visible alongside the account record in Salesforce or HubSpot. A scheduled integration reads /Account with the embedded churn score expansion or calls /Account({Id})/PrimaryChurnScore for each account, then writes the score back to the CRM as a custom field. This puts ChurnZero's risk signal in the workflow where account managers act on it.

List accounts via /Account with OData $top=100, fetch the churn score for each via /Account({Id})/PrimaryChurnScore, and write the score back to the CRM

Customer Health Reporting in BI

Operations teams build BI dashboards that combine ChurnZero churn scores, journey completion rates, and survey NPS with billing data from the finance system. The /ChurnScore, /JourneyProgress, and /SurveyResponse endpoints expose this data with OData filtering so an ETL job can incrementally load only changed records into the warehouse rather than full-refreshing nightly.

Pull /ChurnScore, /JourneyProgress, and /SurveyResponse with an OData $filter on date and load each into the warehouse

At-Risk Account Triage

Customer success leaders want a daily list of accounts whose churn score crossed a threshold so CSMs can intervene before renewal. A job calls /Account with an OData filter on the churn score field, pulls the matching accounts and their primary contacts via /Account({Id})/DirectParentAccount and /Contact, and posts the list to a Slack channel or task system for follow-up.

Query /Account with an OData filter where churn score exceeds a threshold and emit each match with its primary contact

Agent-Driven Customer Success Briefing

A CSM agent preparing for a quarterly business review pulls every signal ChurnZero has on an account — recent events, journey progress, open tasks, churn score history, survey responses — through a single Jentic call sequence. The agent searches Jentic for 'get customer success data from ChurnZero', loads the account-related operations, and assembles a QBR brief without manual export.

Search Jentic for 'get customer success data from ChurnZero', load /Account({Id}), /Event, /Task, and /SurveyResponse, and assemble a QBR brief for one account

Key Endpoints

22 endpoints — jentic publishes the only available openapi specification for churnzero rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/Account

List all accounts with OData filtering

GET

/Account({Id})/PrimaryChurnScore

Get the churn score for an account

GET

/Contact

List all contacts

GET

/Event

List product usage events

GET

/ChurnScore

List churn scores across accounts

GET

/JourneyProgress

List journey progress records

GET

/SurveyResponse

List survey responses

GET

/Account

List all accounts with OData filtering

GET

/Account({Id})/PrimaryChurnScore

Get the churn score for an account

GET

/Contact

List all contacts

GET

/Event

List product usage events

GET

/ChurnScore

List churn scores across accounts

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

ChurnZero Basic auth credentials and the tenant subdomain are stored encrypted in the Jentic vault. Agents receive scoped access — neither the username, API key, nor subdomain leak into agent context.

Intent-based discovery

Agents search by intent (e.g., 'get customer success data from ChurnZero') and Jentic returns the matching OData operation along with its filter parameter schema.

Time to first call

Direct integration: 2-3 days for Basic auth, OData filter handling, and incremental load logic. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using ChurnZero REST API through Jentic.

Why is there no official OpenAPI spec for ChurnZero REST API?

ChurnZero does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call ChurnZero REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the ChurnZero REST API use?

ChurnZero uses HTTP Basic authentication with your username and an API key as the password, base64-encoded in the Authorization header. The base URL is also tenant-specific via the {subdomain} server variable. Through Jentic, both the credentials and subdomain are stored in the vault and bound at execution time.

Can I retrieve churn scores for accounts through the API?

Yes. Call /ChurnScore for the full collection or /Account({Id})/PrimaryChurnScore to fetch the score for a single account. Both support OData $filter and $top so you can target accounts above a risk threshold without paginating through everything.

Does the ChurnZero API support OData filtering?

Yes. Collection endpoints accept standard OData query parameters including $filter, $orderby, $top, and $skip, which is the same shape Microsoft and SAP APIs use for filtering and pagination — useful when incrementally loading changes into a warehouse.

Is the ChurnZero API read-only?

Yes. The public REST API exposes GET endpoints only — accounts, contacts, events, segments, tasks, surveys, churn scores, and journeys are all retrievable but not writable through this surface. Updates to ChurnZero data flow through the JavaScript tracker and integration connectors instead.

How do I pull churn scores into our data warehouse through Jentic?

Run pip install jentic, search for 'get customer success data from ChurnZero', load /ChurnScore with an OData $filter on the calculation date, and execute. Jentic handles the Basic auth header and subdomain binding so the warehouse loader only deals with the parsed payload.