Getting started

Quick start

Authenticate and make your first API call in a couple of minutes. VeilStrat Pro pairs an outbound firehose with a capped REST scalpel — react to what just happened, then pull depth only for companies that matter.

Introduction

The Pro API is designed for fresh signals, not full-database exports. Use webhooks to learn that something changed, then call REST for the dossier or a narrow search.

Surface	Purpose
Firehose	Realtime POSTs when subscribed signal types are written
REST /api/v1	Health, stats, filters, company search, dossier, slices
Downloads	OpenAPI Spec + Postman collection (left nav)

Prerequisites

Pro plan required

API access is limited to active Pro teams. Growth receives 403 plan_not_eligible on every /api/v1 route. Docs pages are public; the API is not.

Authentication

Step 1

Create a team API key in Settings → API (owner). Keys start with vs_. Copy it once — full reveal is one-time.

Step 2

Send it on every REST call as Authorization: Bearer vs_…. Invalid or missing → 401.

Webhook key

Separate secret for outbound firehose (Settings → Webhooks). Never reuse the vs_ key as your webhook auth.

Your first request

Health is exempt from request budgets — safe for uptime checks.

cURL

curl -s "https://app.veilstrat.com/api/v1/health" \
  -H "Authorization: Bearer YOUR_API_KEY"

JSON response

{
  "status": "ok",
  "apiVersion": "v1",
  "timestamp": "2026-08-20T00:00:00.000Z"
}

Recommended loop

Prefer webhook + dossier

Polling large searches burns monthly request and record budgets. Let the firehose tell you what changed, then enrich with GET /companies/{id}.

Firehose event arrives with company.id and signalId.
Enrich via GET /companies/{id}.
Optionally search with POST /companies or GET /slices for more accounts in a buying window.

Base URL

Hosts

Production:  https://app.veilstrat.com/api/v1
Local:       http://localhost:3000/api/v1

Production requires HTTPS. Local HTTP is allowed in development.

Next steps

All endpoints

Request/response samples and field notes for every route. Open reference →

Webhooks

Outbound firehose setup, headers, and payload reference. Open guide →

Rate limits

Budgets, headers, 429 bodies, and integration tips. Open guide →

Examples

Copy-paste curl for common flows. Open examples →