v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB
Users

List all users

List and filter all the users in the team

post/users.list

Request body

offsetnumber
limitnumber
sortstring
direction'ASC' | 'DESC'
querystring
emailsstring[]
filter'all' | 'invited' | 'active' | 'suspended'

The status to filter by

role'admin' | 'member' | 'viewer' | 'guest'

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC",
  "query": "jane"
}

Response

OK

Example response

{
  "data": [
    {
      "name": "Jane Doe"
    }
  ],
  "pagination": {
    "limit": 25
  }
}