Search

Cross-object CRM record search (Cmd+K).

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

qstring

typesstring

limitstring

curl -X GET "https://api.salesos.org/v1/search/records?q=%3Cstring%3E&types=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Whether web search is available

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

Perform a simple web search

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

qRequiredstring

numstring

curl -X GET "https://api.salesos.org/v1/search?q=%3Cstring%3E&num=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

{}

Research a company and generate an AI-powered brief

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

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/search/company-research" \
  -H "Idempotency-Key: <string>" \
  -H "Authorization: Bearer <token>"

{}

Response

TypeScript

Response

TypeScript

Response

TypeScript