curl -X GET "https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
params = {
'limit': 10,
'is_favorite': True
}
response = requests.get(
'https://api.orwel.io/api/v1/identities',
headers=headers,
params=params
)
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"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 250
}
}
Identities
List Identities
Retrieve a paginated list of visitor identities
GET
/
api
/
v1
/
identities
curl -X GET "https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
params = {
'limit': 10,
'is_favorite': True
}
response = requests.get(
'https://api.orwel.io/api/v1/identities',
headers=headers,
params=params
)
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"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 250
}
}
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 identities by email address
string
Filter identities by visitor ID (UUID)
boolean
Filter favorite identities (true/false)
string
Filter identities created after this date (ISO 8601 format)
string
Filter identities created before this date (ISO 8601 format)
Response
array
Array of visitor identity objects
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
object
Pagination information
curl -X GET "https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.orwel.io/api/v1/identities?limit=10&is_favorite=true',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY'
}
}
);
const data = await response.json();
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY'
}
params = {
'limit': 10,
'is_favorite': True
}
response = requests.get(
'https://api.orwel.io/api/v1/identities',
headers=headers,
params=params
)
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"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 250
}
}
⌘I