REST API

Every Vayne feature, one REST API

Create Sales Navigator orders, scrape profiles, enrich contacts and fetch results from your own code. OpenAPI 3 spec, Bearer token, webhooks on completion, and the same credits as the dashboard.

This API lets you create and retrieve scraping orders.
It follows OpenAPI 3 and is secured with a Bearer token.
You can generate your token in API Settings on your Dashboard.
In API Settings and Export Settings, you can also configure:

A webhook URL to be notified when an order is completed.

Your export formats preferences (e.g. Simple or Advanced) to automatically format your exports.

Important: successful test requests (order creation) consume credits.

Prefer to work from an AI agent? Set up the MCP server.

Authentication: Bearer token from API Settings
Specification: OpenAPI 3, JSON and CSV responses
Callbacks: Webhook when an order completes
Plans: Included from Starter, same credits

Build with AI assistants such as Claude, ChatGPT or Cursor

Use our API with AI to build integrations faster. Copy the complete specification and paste it into your AI assistant with your integration requirements.

Download OpenAPI Spec View Raw Spec

Specification copied successfully!

Try pasting the spec with a prompt like:

Help me build a Python script that creates a scraping order and retrieves the results using this API.

Pro Tip: The copied spec includes authentication details and usage notes. Just paste it into your AI assistant and describe what you want to build.

Authorization: Bearer <token> POST /api/orders GET /api/orders/{id}

Interactive reference

Explore every endpoint below, or copy the specification into your AI assistant to generate a working client in minutes.