API Reference
Identities
Companies
Visitor Lists
curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"id": "cc0e8400-e29b-41d4-a716-446655440007",
"email": "john@example.com",
"name": "John Doe",
"avatar": "https://example.com/avatar.jpg",
"username": "johndoe",
"language": "en",
"created_at": "2024-06-15T10:30:00Z",
"workspace_role": "admin",
"joined_at": "2024-06-15T10:30:00Z"
},
{
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"email": "jane@example.com",
"name": "Jane Smith",
"avatar": "https://example.com/avatar2.jpg",
"username": "janesmith",
"language": "en",
"created_at": "2024-07-20T14:20:00Z",
"workspace_role": "member",
"joined_at": "2024-07-20T14:20:00Z"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 5
}
}
Users
List Users
Retrieve a paginated list of workspace members
GET
/
api
/
v1
/
users
curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"id": "cc0e8400-e29b-41d4-a716-446655440007",
"email": "john@example.com",
"name": "John Doe",
"avatar": "https://example.com/avatar.jpg",
"username": "johndoe",
"language": "en",
"created_at": "2024-06-15T10:30:00Z",
"workspace_role": "admin",
"joined_at": "2024-06-15T10:30:00Z"
},
{
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"email": "jane@example.com",
"name": "Jane Smith",
"avatar": "https://example.com/avatar2.jpg",
"username": "janesmith",
"language": "en",
"created_at": "2024-07-20T14:20:00Z",
"workspace_role": "member",
"joined_at": "2024-07-20T14:20:00Z"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 5
}
}
Query Parameters
Maximum number of results to return (max: 100)
Number of results to skip for pagination
Filter users by role (e.g., “admin”, “member”, “viewer”)
Response
Array of workspace user objects
Show User Object
Show User Object
Unique identifier for the user
User’s email address
User’s full name
URL to user’s avatar image
User’s username
User’s preferred language
ISO 8601 timestamp of user account creation
User’s role in the workspace
ISO 8601 timestamp when user joined the workspace
curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": [
{
"id": "cc0e8400-e29b-41d4-a716-446655440007",
"email": "john@example.com",
"name": "John Doe",
"avatar": "https://example.com/avatar.jpg",
"username": "johndoe",
"language": "en",
"created_at": "2024-06-15T10:30:00Z",
"workspace_role": "admin",
"joined_at": "2024-06-15T10:30:00Z"
},
{
"id": "dd0e8400-e29b-41d4-a716-446655440008",
"email": "jane@example.com",
"name": "Jane Smith",
"avatar": "https://example.com/avatar2.jpg",
"username": "janesmith",
"language": "en",
"created_at": "2024-07-20T14:20:00Z",
"workspace_role": "member",
"joined_at": "2024-07-20T14:20:00Z"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"total": 5
}
}
⌘I