List Leads

Retrieve a paginated list of leads for your workspace

GET /api/v1/leads

cURL

curl -X GET "https://api.orwel.io/api/v1/leads?limit=10&source=website" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://api.orwel.io/api/v1/leads?limit=10&source=website',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

params = {
    'limit': 10,
    'source': 'website'
}

response = requests.get(
    'https://api.orwel.io/api/v1/leads',
    headers=headers,
    params=params
)

data = response.json()
print(data)

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "visitor_id": "660e8400-e29b-41d4-a716-446655440001",
      "workspace_id": "770e8400-e29b-41d4-a716-446655440002",
      "code": "lead_001",
      "source": "website",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "properties": {
        "industry": "technology",
        "company_size": "50-100"
      },
      "location": {
        "city": "San Francisco",
        "country": "USA"
      },
      "identity_id": "880e8400-e29b-41d4-a716-446655440003",
      "session_id": "990e8400-e29b-41d4-a716-446655440004",
      "summary": {
        "score": 85,
        "status": "qualified"
      },
      "company_id": "aa0e8400-e29b-41d4-a716-446655440005"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 150
  }
}

Query Parameters

limit · integer · default: "50"

Maximum number of results to return (max: 100)

offset · integer · default: "0"

Number of results to skip for pagination

source · string

Filter leads by source (e.g., “website”, “referral”)

code · string

Filter leads by code

created_after · string

Filter leads created after this date (ISO 8601 format)

created_before · string

Filter leads created before this date (ISO 8601 format)

Response

data · array

Array of lead objects

Show Lead Object

id · string

Unique identifier for the lead

visitor_id · string

Associated visitor ID

workspace_id · string

Workspace ID (always your workspace)

code · string

Lead code or identifier

source · string

Source of the lead

created_at · string

ISO 8601 timestamp of creation

updated_at · string

ISO 8601 timestamp of last update

properties · object

Custom properties (JSONB)

location · object

Location data (JSONB)

identity_id · string

Associated identity ID

session_id · string

Associated session ID

summary · object

Lead summary data (JSONB)

company_id · string

Associated company ID

pagination · object

Pagination information

Show Pagination Object

limit · integer

Number of results per page

offset · integer

Current offset

total · integer

Total number of leads matching the query

cURL

curl -X GET "https://api.orwel.io/api/v1/leads?limit=10&source=website" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://api.orwel.io/api/v1/leads?limit=10&source=website',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

params = {
    'limit': 10,
    'source': 'website'
}

response = requests.get(
    'https://api.orwel.io/api/v1/leads',
    headers=headers,
    params=params
)

data = response.json()
print(data)

Response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "visitor_id": "660e8400-e29b-41d4-a716-446655440001",
      "workspace_id": "770e8400-e29b-41d4-a716-446655440002",
      "code": "lead_001",
      "source": "website",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "properties": {
        "industry": "technology",
        "company_size": "50-100"
      },
      "location": {
        "city": "San Francisco",
        "country": "USA"
      },
      "identity_id": "880e8400-e29b-41d4-a716-446655440003",
      "session_id": "990e8400-e29b-41d4-a716-446655440004",
      "summary": {
        "score": 85,
        "status": "qualified"
      },
      "company_id": "aa0e8400-e29b-41d4-a716-446655440005"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 150
  }
}