curl -X GET "https://api.orwel.io/api/v1/leads?limit=10&source=website" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/leads?limit=10&source=website',
{
headers: {
'Authorization': 'Bearer orwel_sk_YOUR_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer orwel_sk_YOUR_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)
{
"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
}
}
Leads
List Leads
Retrieve a paginated list of leads for your workspace
GET
/
api
/
v1
/
leads
curl -X GET "https://api.orwel.io/api/v1/leads?limit=10&source=website" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/leads?limit=10&source=website',
{
headers: {
'Authorization': 'Bearer orwel_sk_YOUR_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer orwel_sk_YOUR_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)
{
"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
}
}
Requires an API key (
orwel_sk_) with the leads:read scope.id is unique and never changes, so an external system can upsert by it. When the same person converts again, Orwel adds a conversion to the same lead instead of creating a new one; read each of them with List Conversions.
Query Parameters
integer
default:"50"
Maximum number of results to return (max: 100)
integer
default:"0"
Number of results to skip for pagination
string
Filter leads by source (e.g., “website”, “referral”)
string
Filter leads by code
string
Filter leads created after this date (ISO 8601 format)
string
Filter leads created before this date (ISO 8601 format)
Response
array
Array of lead objects
Show Lead Object
Show Lead Object
string
Unique identifier for the lead
string
Associated visitor ID
string
Workspace ID (always your workspace)
string
Lead code or identifier
string
Source of the lead
string
ISO 8601 timestamp of creation
string
ISO 8601 timestamp of last update
object
Custom properties (JSONB)
object
Location data (JSONB)
string
Associated identity ID
string
Associated session ID
object
Lead summary data (JSONB)
string
Associated company ID
object
curl -X GET "https://api.orwel.io/api/v1/leads?limit=10&source=website" \
-H "Authorization: Bearer orwel_sk_YOUR_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/leads?limit=10&source=website',
{
headers: {
'Authorization': 'Bearer orwel_sk_YOUR_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer orwel_sk_YOUR_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)
{
"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
}
}