List Users | Orwel Docs
Docs

List Users

Retrieve a paginated list of workspace members

GET https://api.orwel.io/api/v1/users

Query Parameters

limitintegerquerydefault: 50

Maximum number of results to return (max: 100)

offsetintegerquerydefault: 0

Number of results to skip for pagination

rolestringquery

Filter users by role (e.g., "admin", "member", "viewer")

Response

dataarray

Array of workspace user objects

Show User Object
idstring

Unique identifier for the user

emailstring

User's email address

namestring

User's full name

avatarstring

URL to user's avatar image

usernamestring

User's username

languagestring

User's preferred language

created_atstring

ISO 8601 timestamp of user account creation

workspace_rolestring

User's role in the workspace

joined_atstring

ISO 8601 timestamp when user joined the workspace

paginationobject

Pagination information

Show Pagination Object
limitinteger

Number of results per page

offsetinteger

Current offset

totalinteger

Total number of users in the workspace

Request
curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
  -H "Authorization: Bearer orwel_sk_YOUR_KEY"
Response
{
  "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
  }
}