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

Dev
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.

4 curtidas
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?

1 curtida
4

Yes :smile:

No idea.

1 curtida
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.

5 curtidas
6

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

2 curtidas
7

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

1 curtida
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
7 curtidas
9

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

1 curtida
10

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

4 curtidas
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.

2 curtidas
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.

4 curtidas
14

Uma resposta breve e atualizada: uma lista paginada de usuários está disponível de duas formas:

  1. Lista pública de usuários como uma “listagem de diretório”
  2. Lista de usuários por “flag” Onde o {flag} na URL deve ser substituído por um Enum

Abraços,
ABK

4 curtidas
15

Olá,

Lista de usuários por “flag”

Existe uma flag para obter todos os usuários? Algo como https://{defaultHost}/admin/users/list/all.json

1 curtida
16

Não consegui buscar todos os usuários usando este endpoint. Alguma explicação?

17

Outra solução um pouco hacky, mas que funciona para mim:

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

Usar a flag “new” em vez de “active” deve fornecer TODOS os usuários. Basta ordenar por criação em ordem crescente e você obterá todos os usuários, do mais antigo ao mais recente. Ainda será necessário usar paginação para buscar todos os usuários; caso contrário, a solicitação pode ficar excessivamente grande se houver muitos usuários.

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

Apenas para constar:

    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']}")
6 curtidas