Get Lead

Retrieve a specific lead by ID

GET /api/v1/leads/{id}

cURL

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)

200 OK

{
  "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

id · string · required

The unique identifier (UUID) of the lead

Response

data · object

The lead object

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

cURL

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)

200 OK

{
  "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"
}