curl -X GET "https://api.orwel.io/api/v1/identities/ee0e8400-e29b-41d4-a716-446655440009" \
-H "Authorization: Bearer YOUR_API_KEY"
const identityId = 'ee0e8400-e29b-41d4-a716-446655440009';
const response = await fetch(
`https://api.orwel.io/api/v1/identities/${identityId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
identity_id = 'ee0e8400-e29b-41d4-a716-446655440009'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/identities/{identity_id}',
headers=headers
)
data = response.json()
{
"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"
}
}
{
"error": "not_found",
"message": "Identity not found or does not belong to your workspace"
}
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"
const identityId = 'ee0e8400-e29b-41d4-a716-446655440009';
const response = await fetch(
`https://api.orwel.io/api/v1/identities/${identityId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
identity_id = 'ee0e8400-e29b-41d4-a716-446655440009'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/identities/{identity_id}',
headers=headers
)
data = response.json()
{
"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"
}
}
{
"error": "not_found",
"message": "Identity not found or does not belong to your workspace"
}
Path Parameters
string
required
The unique identifier (UUID) of the identity
Response
object
The visitor identity object
Show Identity Object
Show Identity Object
string
Unique identifier for the identity
string
Workspace ID (always your workspace)
string
Associated visitor ID
string
Email address
string
Full name
object
Custom traits (JSONB)
string
ISO 8601 timestamp of first visit
string
ISO 8601 timestamp of last visit
string
IP address
string
City
string
Country
boolean
Whether identity is marked as favorite
string
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"
const identityId = 'ee0e8400-e29b-41d4-a716-446655440009';
const response = await fetch(
`https://api.orwel.io/api/v1/identities/${identityId}`,
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
identity_id = 'ee0e8400-e29b-41d4-a716-446655440009'
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
response = requests.get(
f'https://api.orwel.io/api/v1/identities/{identity_id}',
headers=headers
)
data = response.json()
{
"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"
}
}
{
"error": "not_found",
"message": "Identity not found or does not belong to your workspace"
}