SalesOS

Account Health

Account health scoring and monitoring

GET /account-health/dashboard Health dashboard with filtering

GET
/v1/account-health/dashboard

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Query Parameters

statusstring
stagestring
tierstring
searchstring
curl -X GET "https://api.salesos.org/v1/account-health/dashboard?status=%3Cstring%3E&stage=%3Cstring%3E&tier=%3Cstring%3E&search=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

GET /account-health/distribution Health distribution chart data

GET
/v1/account-health/distribution

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/account-health/distribution" \
  -H "Authorization: Bearer <token>"

Get last daily health recalculation result

GET
/v1/account-health/churn/last-run

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/account-health/churn/last-run" \
  -H "Authorization: Bearer <token>"

{}

Get save plan outcome statistics

GET
/v1/account-health/churn/stats

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

curl -X GET "https://api.salesos.org/v1/account-health/churn/stats" \
  -H "Authorization: Bearer <token>"

Manually trigger daily health recalculation

POST
/v1/account-health/churn/recalculate

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/account-health/churn/recalculate" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

{}

Calculate comprehensive health score with component breakdown

GET
/v1/account-health/{accountId}/health-score

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

accountIdRequiredstring
curl -X GET "https://api.salesos.org/v1/account-health/<string>/health-score" \
  -H "Authorization: Bearer <token>"

{}

Predict churn probability with signals and historical comparison

GET
/v1/account-health/{accountId}/churn-prediction

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

accountIdRequiredstring
curl -X GET "https://api.salesos.org/v1/account-health/<string>/churn-prediction" \
  -H "Authorization: Bearer <token>"

{}

Get the current active save plan for an account

GET
/v1/account-health/{accountId}/save-plan

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

accountIdRequiredstring
curl -X GET "https://api.salesos.org/v1/account-health/<string>/save-plan" \
  -H "Authorization: Bearer <token>"

{}

Generate AI-powered save plan with automated task creation

POST
/v1/account-health/{accountId}/save-plan

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

accountIdRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/account-health/<string>/save-plan" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

{}

Track save plan outcome (recovered/churned/still at risk)

POST
/v1/account-health/{accountId}/save-plan/outcome

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Request Body

application/jsonRequired

Path Parameters

accountIdRequiredstring

Header Parameters

Idempotency-Keystring

Unique key (a UUID is ideal) that makes this write safe to retry for 24 hours: a retry with the same body replays the original response (Idempotent-Replayed: true); the same key with a different body is a 409.

Maximum length: 255
curl -X POST "https://api.salesos.org/v1/account-health/<string>/save-plan/outcome" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}'

Get account health

GET
/v1/account-health/{accountId}

Authorization

AuthorizationRequiredBearer <token>

Session token from the SalesOS web app.

In: header

X-API-Key<token>

API key from Settings → API Keys. Authorization: ApiKey <key> is also accepted. Each operation lists the scope it needs under x-api-key-scopes.

In: header

Path Parameters

accountIdRequiredstring
curl -X GET "https://api.salesos.org/v1/account-health/<string>" \
  -H "Authorization: Bearer <token>"

{}

Pipeline Simulation

What-if scenario modeling for pipeline

Health Auto Triage

Automatic detection of at-risk accounts