Get Identity

Retrieve a specific visitor identity by ID

GET /api/v1/identities/{id}

cURL

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()

200 OK

{
  "data": {
    "id": "ee0e8400-e29b-41d4-a716-446655440009",
    "workspace_id": "770e8400-e29b-41d4-a716-446655440002",
    "visitor_id": "660e8400-e29b-41d4-a716-446655440001",
    "email": "[e-mail]",
    "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

id · string · required

The unique identifier (UUID) of the identity

Response

data · object

The visitor identity object

Show Identity Object

id · string

Unique identifier for the identity

workspace_id · string

Workspace ID (always your workspace)

visitor_id · string

Associated visitor ID

email · string

Email address

name · string

Full name

traits · object

Custom traits (JSONB)

first_seen · string

ISO 8601 timestamp of first visit

last_seen · string

ISO 8601 timestamp of last visit

ip · string

IP address

city · string

City

country · string

Country

is_favorite · boolean

Whether identity is marked as favorite

created_at · string

ISO 8601 timestamp of creation

cURL

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()

200 OK

{
  "data": {
    "id": "ee0e8400-e29b-41d4-a716-446655440009",
    "workspace_id": "770e8400-e29b-41d4-a716-446655440002",
    "visitor_id": "660e8400-e29b-41d4-a716-446655440001",
    "email": "[e-mail]",
    "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"
}