List Users

Retrieve a paginated list of workspace members

GET /api/v1/users

cURL

curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://api.orwel.io/api/v1/users?limit=10',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

params = {
    'limit': 10
}

response = requests.get(
    'https://api.orwel.io/api/v1/users',
    headers=headers,
    params=params
)

data = response.json()
print(data)

Response

{
  "data": [
    {
      "id": "cc0e8400-e29b-41d4-a716-446655440007",
      "email": "[e-mail]",
      "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": "[e-mail]",
      "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

limit · integer · default: "50"

Maximum number of results to return (max: 100)

offset · integer · default: "0"

Number of results to skip for pagination

role · string

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

Response

data · array

Array of workspace user objects

Show User Object

id · string

Unique identifier for the user

email · string

User’s email address

name · string

User’s full name

avatar · string

URL to user’s avatar image

username · string

User’s username

language · string

User’s preferred language

created_at · string

ISO 8601 timestamp of user account creation

workspace_role · string

User’s role in the workspace

joined_at · string

ISO 8601 timestamp when user joined the workspace

pagination · object

Pagination information

Show Pagination Object

limit · integer

Number of results per page

offset · integer

Current offset

total · integer

Total number of users in the workspace

cURL

curl -X GET "https://api.orwel.io/api/v1/users?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch(
  'https://api.orwel.io/api/v1/users?limit=10',
  {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

params = {
    'limit': 10
}

response = requests.get(
    'https://api.orwel.io/api/v1/users',
    headers=headers,
    params=params
)

data = response.json()
print(data)

Response

{
  "data": [
    {
      "id": "cc0e8400-e29b-41d4-a716-446655440007",
      "email": "[e-mail]",
      "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": "[e-mail]",
      "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
  }
}