Getting started

Examples

Copy-paste curl for common flows. For annotated field tables and notes per route, see All endpoints.

Health

cURL

curl -s "${BASE_URL}/api/v1/health" \
  -H "Authorization: Bearer YOUR_API_KEY"

Filters catalog

cURL

curl -s "${BASE_URL}/api/v1/filters" \
  -H "Authorization: Bearer YOUR_API_KEY"

Company search

signal_query is required.

cURL

curl -s -X POST "${BASE_URL}/api/v1/companies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "signal_query": "signal:hiring:30d & tool:clay",
    "countries": ["US"],
    "page": 1,
    "pageSize": 50
  }'

Company dossier

Ids are UUIDs — same as firehose company.id.

cURL

curl -s "${BASE_URL}/api/v1/companies/4066c846-48ea-403a-97b1-fd60503fdb97" \
  -H "Authorization: Bearer YOUR_API_KEY"

Slice search

Requires slice + at least one filter.

cURL

curl -s "${BASE_URL}/api/v1/slices?slice=ai-sdr-hiring&countries=US&scoreMin=70" \
  -H "Authorization: Bearer YOUR_API_KEY"

Stats

cURL

curl -s "${BASE_URL}/api/v1/stats" \
  -H "Authorization: Bearer YOUR_API_KEY"

Firehose

Outbound webhooks use the shared envelope (eventId, type, action, company, signal). See Webhooks. Import the Postman collection for REST folders.