API Reference
Identities
Companies
Visitor Lists
curl -X GET "https://api.orwel.io/api/v1/identities/ee0e8400-e29b-41d4-a716-446655440009" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"id": "ee0e8400-e29b-41d4-a716-446655440009",
"workspace_id": "770e8400-e29b-41d4-a716-446655440002",
"visitor_id": "660e8400-e29b-41d4-a716-446655440001",
"email": "user@example.com",
"name": "John Visitor",
"traits": {
"plan": "enterprise",
"company": "Acme Corp"
},
"first_seen": "2025-01-10T08:00:00Z",
"last_seen": "2025-01-15T16:30:00Z",
"ip": "192.168.1.1",
"city": "San Francisco",
"country": "USA",
"is_favorite": true,
"created_at": "2025-01-10T08:00:00Z"
}
}
Identities
Get Identity
Retrieve a specific visitor identity by ID
GET
/
api
/
v1
/
identities
/
{id}
curl -X GET "https://api.orwel.io/api/v1/identities/ee0e8400-e29b-41d4-a716-446655440009" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"id": "ee0e8400-e29b-41d4-a716-446655440009",
"workspace_id": "770e8400-e29b-41d4-a716-446655440002",
"visitor_id": "660e8400-e29b-41d4-a716-446655440001",
"email": "user@example.com",
"name": "John Visitor",
"traits": {
"plan": "enterprise",
"company": "Acme Corp"
},
"first_seen": "2025-01-10T08:00:00Z",
"last_seen": "2025-01-15T16:30:00Z",
"ip": "192.168.1.1",
"city": "San Francisco",
"country": "USA",
"is_favorite": true,
"created_at": "2025-01-10T08:00:00Z"
}
}
Path Parameters
The unique identifier (UUID) of the identity
Response
The visitor identity object
Show Identity Object
Show Identity Object
Unique identifier for the identity
Workspace ID (always your workspace)
Associated visitor ID
Email address
Full name
Custom traits (JSONB)
ISO 8601 timestamp of first visit
ISO 8601 timestamp of last visit
IP address
City
Country
Whether identity is marked as favorite
ISO 8601 timestamp of creation
curl -X GET "https://api.orwel.io/api/v1/identities/ee0e8400-e29b-41d4-a716-446655440009" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"id": "ee0e8400-e29b-41d4-a716-446655440009",
"workspace_id": "770e8400-e29b-41d4-a716-446655440002",
"visitor_id": "660e8400-e29b-41d4-a716-446655440001",
"email": "user@example.com",
"name": "John Visitor",
"traits": {
"plan": "enterprise",
"company": "Acme Corp"
},
"first_seen": "2025-01-10T08:00:00Z",
"last_seen": "2025-01-15T16:30:00Z",
"ip": "192.168.1.1",
"city": "San Francisco",
"country": "USA",
"is_favorite": true,
"created_at": "2025-01-10T08:00:00Z"
}
}
⌘I