curl -X GET "https://api.orwel.io/api/v1/leads/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
const leadId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.orwel.io/api/v1/leads/${leadId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
lead_id = '550e8400-e29b-41d4-a716-446655440000'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/leads/{lead_id}',
headers=headers
)
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"
}
}
{
"error": "not_found",
"message": "Lead not found or does not belong to your workspace"
}
Leads
Get Lead
Retrieve a specific lead by ID
GET
/
api
/
v1
/
leads
/
{id}
curl -X GET "https://api.orwel.io/api/v1/leads/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
const leadId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.orwel.io/api/v1/leads/${leadId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
lead_id = '550e8400-e29b-41d4-a716-446655440000'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/leads/{lead_id}',
headers=headers
)
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"
}
}
{
"error": "not_found",
"message": "Lead not found or does not belong to your workspace"
}
Path Parameters
string
required
The unique identifier (UUID) of the lead
Response
object
The lead object
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
curl -X GET "https://api.orwel.io/api/v1/leads/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"
const leadId = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(
`https://api.orwel.io/api/v1/leads/${leadId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
console.log(data);
import requests
lead_id = '550e8400-e29b-41d4-a716-446655440000'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/leads/{lead_id}',
headers=headers
)
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"
}
}
{
"error": "not_found",
"message": "Lead not found or does not belong to your workspace"
}
⌘I