SalesOS

Integrations

Third-party integration management

Get status of all integrations for current organization

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

All integration statuses

Get status of a specific integration for current organization

GET
/v1/integrations/{integrationType}/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

Path Parameters

integrationTypeRequiredstring
curl -X GET "https://api.salesos.org/v1/integrations/<string>/status" \
  -H "Authorization: Bearer <token>"

Integration status

Test connection for an integration

POST
/v1/integrations/{integrationType}/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

Path Parameters

integrationTypeRequiredstring

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

Connection test result

Initiate OAuth flow for an integration

POST
/v1/integrations/{integrationType}/connect

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

integrationTypeRequiredstring

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/integrations/<string>/connect" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

OAuth URL or connection result

Trigger sync for an integration

POST
/v1/integrations/{integrationType}/sync

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

integrationTypeRequiredstring

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/integrations/<string>/sync" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

Sync result

Get list of all available integrations

GET
/v1/integrations/all

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

All available integrations

Health check a single integration

GET
/v1/integrations/{provider}/health

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
curl -X GET "https://api.salesos.org/v1/integrations/<string>/health" \
  -H "Authorization: Bearer <token>"

Single integration health result

Customer 360

Unified customer profile view

Sandboxes

Sandbox environment management