Sign in
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
  }
}

Changes

Changed in 2 of the 6 revisions of this API.7

  • fdf2ec9c9df41See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 7b33b538cd7d6See the full diff
    • ○

      added the optional property data to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 403 status

      response-optional-property-added