annict.api.API.search_users

API.search_users(fields=None, filter_ids=None, filter_usernames=None, page=None, per_page=None, sort_id=None)[source]

Get users information

Reference:

https://docs.annict.com/ja/api/v1/users.html
Parameters:
  • fields (list of str) – (optional) Narrow down the fields of data contained in the response body.
  • filter_ids (list of int) – (optional) Filter results by IDs.
  • filter_usernames (list of str) – (optional) Filter results by usernames.
  • page (int) – (optional) Specify the number of pages.
  • per_page (int) – (optional) Specify how many items to acquire per page.
  • sort_id (str) – (optional) Sort the results by their ID. You can specify asc or desc.
Returns:

list of User objects.
Return type:

annict.models.ResultSet