From signup to your first result

Create a workspace, get an API key, and run a bounded people search. Your workspace starts with 100 one-time credits after you verify your email and open the dashboard. No payment card or customer LinkedIn connection is required.

Availability: the website may be running as a preview. If signup says it is not open, authentication and API deployment are not configured for that host yet. A preview is not a working production account.

1. Create and verify your account

Create an account, then follow the verification link sent to your email. Sign in and open the dashboard. The first authenticated workspace request creates your workspace and grants 100 credits transactionally. Reloading the dashboard does not grant another 100 credits.

Use an address you can receive email at. If the link expires, request a new verification email. See authentication for sign-in and recovery.

2. Create an API key

Open API keys, give your key a descriptive name, and create it. Copy the secret immediately: it is shown only once. The key list contains its prefix, not a recoverable secret.

Keep the key on your server or in an environment variable. The dashboard session token cannot execute data actions.

bash

export API_URL="https://YOUR_API_HOST"
export API_KEY="YOUR_SECRET_API_KEY"

Set API_URL to the API base host shown in your configured workspace. Include the deployment stage if your API host has one. Do not append /v1 to this variable: the examples include it in each path.

3. Run a people search

This request reserves at most 10 credits. Each returned person costs 1 credit; a result containing 6 people uses 6 credits and returns the unused 4 to your available balance.

bash

curl "$API_URL/v1/actions/salesnavigator-search-people/run/live" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-search-001" \
  -d '{
    "input": { "keywords": "founder" },
    "max_results": 10,
    "max_credits": 10
  }'

keywords is a keyword query. It does not translate natural language into Sales Navigator filters.

4. Read the response

A completed response has status: "completed" and an output array. This deliberately small example uses fictional data; actual fields depend on the source.

json

{
  "id": "00000000-0000-4000-8000-000000000001",
  "action": "salesnavigator-search-people",
  "status": "completed",
  "output": [{
    "full_name": "Alex Example",
    "company_name": "Example Studio",
    "job_title": "Founder",
    "location": "London"
  }],
  "credits_used": 1,
  "credits_reserved": 0,
  "created_at": "2026-09-08T10:00:00.000Z",
  "completed_at": "2026-09-08T10:00:01.000Z",
  "completeness": { "has_more": false, "scope": "single_page" }
}

A live request can also return 202 with queued or processing. Poll GET /v1/runs/{id} with the same API key. HTTP 200 alone is not proof of successful extraction: a failed terminal run is also returned with 200 and an error in the body.

5. Check your credits

Return to the dashboard. After the example above, a newly created 100-credit workspace has 99 credits. Reservations appear separately while work is pending. A full profile uses 20 credits, so the introductory grant can fund up to five successful full-profile records, or a mix of lower-cost actions.

Repeated requests with the same idempotency key and identical body reuse the original run. Use a new key when you intentionally want new work.