How do I get a list of all users from the API?

开发
1

I see that I can get a list of users using the API using http://discourse.example.net/admin/users.json, but I get only 100 users and I don’t know how the paging for that works? The interface doesn’t seem to display more than 100 users if you go to the admin part.

2

There is no paging.
There is no scrolling.
Currently the only way to get more is to use “Export” :sadpanda:

3

sad panda indeed :frowning: The exported list doesn’t include the same data, and the way it happens makes it hard to grab programatically.

Any idea if paging for users is wanted by anyone else and if it is something that may be implemented at some stage?

4

Yes :smile:

No idea.

5

Any thought if this will be fixed/expanded? We really need API access to access our user lists. Limiting at 100 just doesn’t make sense.

6

Has this been addressed? This would be really useful to my user import script

7

I’d also love to see this, to use in scripts that process the whole user base in some way, like this:

8

Whilst not immediately obvious…

It is possible to get a list of all users via the groups API endpoint available to admins.

You’ll have to iterate over the following groups:

  • trust_level_0
  • trust_level_1
  • trust_level_2
  • trust_level_3
  • trust_level_4

But they do support both limit and offset parameters:

/groups/trust_level_0/members.json?limit=50&offset=50
9

This is a great workaround, but begs the question: Is there a reason these parameters are not supported on /users.json ?

10

It was recently noted that you only need to iterate trust_level_0:

11

So this API doesn’t give emails too. This means that I would have to get the whole list then interate through and pull each user individually to get all the appropriate info (admin, moderator, etc…) Is that correct

12

Yes I believe that is correct. I don’t think paging has been added yet to /admin/users.json.

13

Sorry the reply so late but that’s the first search result for “get list of all users discourse”…

You can implement read-only endpoints with the Data Explorer plugin.

  • Install the plugin
  • Create your query, with inputs if needed
  • Issue a POST request on /admin/plugins/explorer/queries/[id]/run (with [id] being your query ID)

You can also implement paging with limit/offset inputs I guess, but never tried.

For example, I’m using it to check if a given OAuth user ID is already registered on my instance through discourse-oauth2-basic.

14

简要更新后的答案：分页用户列表可通过两种方式获取：

  1. 公开用户列表，作为“目录列表”
  2. 按“标志”筛选的用户列表，其中 URL 中的 {flag} 应替换为一个枚举值

祝好，
ABK

15

你好，关于

按“标志”列出用户

是否有某个标志可以获取所有用户？例如 https://{defaultHost}/admin/users/list/all.json

16

我无法通过此端点获取所有用户，有什么解释吗？

17

另一个有点取巧但对我有效的解决方案：

/admin/users/list/active.json?show_emails=true&page=${page}
18

使用“new”标志而不是“active”应该能给你所有用户。只需按创建时间升序排序，就会按从旧到新的顺序列出所有用户。你仍然需要使用分页来获取所有用户，否则如果你的用户数量很多，请求可能会变得过大。

/admin/users/list/new?asc=true&order=created&page=0
19

仅供记录：

    for page in itertools.count(start=1):
        userlist = api_get(f"admin/users/list/new.json?page={page}")
        if not userlist:
            break
        for user in userlist:
            print(f"{user['id']:5} {user['username']}")