Karzoun Docs

QUERY

users(sortField: String, sortDirection: SortDirection, page: Int, perPage: Int, status: String, excludeIds: Boolean, searchValue: String, isActive: Boolean, requireUsername: Boolean, ids: [String], workspaceIds: [String], branchIds: [String], departmentIds: [String], availability: UserChatStatus): UserListResponse

Arguments

sortField

String

sortDirection

SortDirection

page

Int

perPage

Int

status

String

excludeIds

Boolean

searchValue

String

isActive

Boolean

requireUsername

Boolean

ids

[String]

workspaceIds

[String]

branchIds

[String]

departmentIds

[String]

availability

UserChatStatus

Returns

UserListResponse

data

[User]

pagination

PaginationInfo!

Query

query Users {
  users {
    data {
      _id
      createdAt
      username
      email
      userPreferences
      availability
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "users": {
      "data": [
        {
          "_id": "string",
          "createdAt": "value",
          "username": "string",
          "email": "string",
          "userPreferences": "value",
          "availability": "offline"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Last modified on August 8, 2026

⌘I

Query

query Users {
  users {
    data {
      _id
      createdAt
      username
      email
      userPreferences
      availability
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "users": {
      "data": [
        {
          "_id": "string",
          "createdAt": "value",
          "username": "string",
          "email": "string",
          "userPreferences": "value",
          "availability": "offline"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

Getting started

Guides

Try it

Queries

Mutations

Types

users

Arguments

Returns