---
title: "GET /api/v1/admin/users"
method: GET
path: "/api/v1/admin/users"
tags: ["platformAdmin"]
---

# GET /api/v1/admin/users

`GET /api/v1/admin/users`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/admin/users`
- Auth: none required

## Query parameters

- `q` string, nullable
- `limit` string, nullable
- `offset` string, nullable

## Response `200`

AdminUserSearchResult

- AdminUserSearchResultEncoded
  - `users` AdminUserSummaryEncoded[], required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `image` string, nullable, required
    - `role` string, required
    - `banned` boolean, required
    - `banReason` string, nullable, required
    - `banExpires` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `createdAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `organizationCount` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `companyType` string, nullable, required
    - `companyTypeDetail` string, nullable, required
  - `total` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'
  - `limit` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'
  - `offset` union, required
    - number
    - 'Infinity' | '-Infinity' | 'NaN'

## Other responses

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)