SalesOS

Data Enrichment

External data enrichment

Enrich a single lead

Enriches a lead with data from configured enrichment providers (ZoomInfo, Apollo, Clearbit)

POST
/v1/enrichment/lead/{id}

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

idRequiredstring

Lead ID to enrich

Query Parameters

providerstring

Specific provider to use (optional)

Value in: "zoominfo" | "apollo" | "clearbit"
forceboolean

Force re-enrichment even if recently enriched

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/enrichment/lead/<string>?provider=zoominfo&force=true" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Lead enriched successfully

Enrich a single contact

Enriches a contact with data from configured enrichment providers

POST
/v1/enrichment/contact/{id}

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

idRequiredstring

Contact ID to enrich

Query Parameters

providerstring

Specific provider to use (optional)

Value in: "zoominfo" | "apollo" | "clearbit"
forceboolean

Force re-enrichment even if recently enriched

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/enrichment/contact/<string>?provider=zoominfo&force=true" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Contact enriched successfully

Enrich a single account

Enriches an account with company data from configured enrichment providers

POST
/v1/enrichment/account/{id}

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

idRequiredstring

Account ID to enrich

Query Parameters

providerstring

Specific provider to use (optional)

Value in: "zoominfo" | "apollo" | "clearbit"
forceboolean

Force re-enrichment even if recently enriched

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/enrichment/account/<string>?provider=zoominfo&force=true" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Account enriched successfully

Bulk enrich multiple entities

Enriches multiple leads, contacts, or accounts in a single request

POST
/v1/enrichment/bulk

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
entityTypeRequiredstring

Entity type to enrich

Value in: "lead" | "contact" | "account"
idsRequiredarray<string>

Entity IDs to enrich

providerstring

Specific provider to use

Value in: "zoominfo" | "apollo" | "clearbit"
forceboolean

Force re-enrichment even if recently enriched

Default: false

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/enrichment/bulk" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "lead",
    "ids": [
      "string"
    ],
    "provider": "zoominfo",
    "force": false
  }'

Bulk enrichment completed

Get enrichment provider status

Returns the connection status of all configured enrichment providers

GET
/v1/enrichment/status

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/enrichment/status" \
  -H "Authorization: Bearer <token>"

Provider status retrieved

{
  "providers": [
    {
      "provider": "zoominfo",
      "connected": true,
      "configured": true,
      "status": "string",
      "error": "string"
    }
  ],
  "bestProvider": "string"
}

List available enrichment providers

Returns a list of all enrichment providers with their capabilities

GET
/v1/enrichment/providers

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/enrichment/providers" \
  -H "Authorization: Bearer <token>"

Providers list retrieved

Test enrichment provider connection

Tests connectivity to enrichment providers using a sample lookup

POST
/v1/enrichment/test

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

providerstring

Specific provider to test (tests all if not specified)

Value in: "zoominfo" | "apollo" | "clearbit"

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/enrichment/test?provider=zoominfo" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Connection test results

Test specific enrichment provider

Tests connectivity to a specific enrichment provider

POST
/v1/enrichment/test/{provider}

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

providerRequiredstring

Provider to test

Value in: "zoominfo" | "apollo" | "clearbit"

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/enrichment/test/zoominfo" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Connection test result

Preview lead enrichment

Shows what data would be enriched without actually updating the lead

POST
/v1/enrichment/preview/lead/{id}

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

idRequiredstring

Lead ID to preview enrichment for

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/enrichment/preview/lead/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Enrichment preview returned

Preview contact enrichment

Shows what data would be enriched without actually updating the contact

POST
/v1/enrichment/preview/contact/{id}

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

idRequiredstring

Contact ID to preview enrichment for

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/enrichment/preview/contact/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Enrichment preview returned

Preview account enrichment

Shows what data would be enriched without actually updating the account

POST
/v1/enrichment/preview/account/{id}

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

idRequiredstring

Account ID to preview enrichment for

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/enrichment/preview/account/<string>" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Enrichment preview returned

Duplicate Detection

Duplicate record detection and merge

Auto Enrichment

Automatic record enrichment triggers