GET
/
admin
/
user
shell
curl --request GET \
  --url 'https://app.teable.cn/api/admin/user?includeDeleted=SOME_BOOLEAN_VALUE&page=SOME_NUMBER_VALUE&pageSize=SOME_NUMBER_VALUE&search=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatar": "<string>",
      "createdTime": "<string>",
      "deletedTime": "<string>",
      "lastSignTime": "<string>",
      "deactivatedTime": "<string>",
      "isAdmin": true
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
includeDeleted
boolean | null
​
page
number
default:1
Required range: x >= 1
​
pageSize
number
default:10
Required range: 1 <= x <= 100
​
search
string

Response

200 - application/json

Returns paginated users for the instance.

​
data
object[]
required
​
total
number
required
​
page
number
required
​
pageSize
number
required