SalesOS

Buyer Intent

Buyer engagement signals and intent scoring

Get all buyer intent scores (multi-signal scoring)

GET
/v1/buyer-intent/scores

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/buyer-intent/scores" \
  -H "Authorization: Bearer <token>"

Get buyer intent score for a specific contact

GET
/v1/buyer-intent/scores/{contactId}

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

contactIdRequiredstring

Contact ID

curl -X GET "https://api.salesos.org/v1/buyer-intent/scores/<string>" \
  -H "Authorization: Bearer <token>"

{}

Get full intent signals breakdown for an account

GET
/v1/buyer-intent/accounts/{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

Account ID

curl -X GET "https://api.salesos.org/v1/buyer-intent/accounts/<string>" \
  -H "Authorization: Bearer <token>"

{}

Get intent score history for an account (trend data)

GET
/v1/buyer-intent/accounts/{accountId}/history

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

Account ID

Query Parameters

daysstring

Number of days of history (default 30, max 90)

curl -X GET "https://api.salesos.org/v1/buyer-intent/accounts/<string>/history?days=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Trigger on-demand intent score recalculation for an account

POST
/v1/buyer-intent/accounts/{accountId}/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

Path Parameters

accountIdRequiredstring

Account ID

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/buyer-intent/accounts/<string>/recalculate" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

{}

Get dashboard-level intent statistics

GET
/v1/buyer-intent/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/buyer-intent/stats" \
  -H "Authorization: Bearer <token>"

Get intent alerts including surge detections

GET
/v1/buyer-intent/alerts

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/buyer-intent/alerts" \
  -H "Authorization: Bearer <token>"

Get buyer intent scoring configuration

GET
/v1/buyer-intent/config

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/buyer-intent/config" \
  -H "Authorization: Bearer <token>"

Partially update buyer intent scoring configuration

PATCH
/v1/buyer-intent/config

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 PATCH "https://api.salesos.org/v1/buyer-intent/config" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Update buyer intent scoring configuration (full replace)

PUT
/v1/buyer-intent/config

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 PUT "https://api.salesos.org/v1/buyer-intent/config" \
  -H "Authorization: Bearer <token>"

Trigger recalculation for a contact (legacy endpoint)

POST
/v1/buyer-intent/recalculate/{entityId}

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

entityIdRequiredstring

Contact ID to recalculate

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/buyer-intent/recalculate/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

{}

Get top prospects ranked by intent score

GET
/v1/buyer-intent/top-prospects

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

limitstring

Number of results (default 50)

curl -X GET "https://api.salesos.org/v1/buyer-intent/top-prospects?limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"