Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

users

Search users

post/app/v1/users/search

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'id' | 'name' | 'quicksight' | 'timezone' | 'status' | 'email' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "timezone": "America/Los_Angeles"
  }
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "timezone": "America/Los_Angeles"
    }
  ]
}