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

Entwickler
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 „Gefällt mir“
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 „Gefällt mir“
4

Yes :smile:

No idea.

1 „Gefällt mir“
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 „Gefällt mir“
6

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

2 „Gefällt mir“
7

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

1 „Gefällt mir“
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 „Gefällt mir“
9

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

1 „Gefällt mir“
10

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

4 „Gefällt mir“
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 „Gefällt mir“
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 „Gefällt mir“
14

Eine kurze, aktualisierte Antwort: Eine paginierte Liste von Benutzern ist auf zwei Arten verfügbar:

  1. Öffentliche Benutzerliste als „Verzeichnisliste“
  2. Benutzerliste nach „Flagge", wobei das {flag} in der URL durch ein Enum ersetzt werden muss

Viele Grüße,
ABK

4 „Gefällt mir“
15

Hallo,

Liste der Benutzer nach „Flagge"

Gibt es eine Flagge, um alle Benutzer abzurufen? Zum Beispiel https://{defaultHost}/admin/users/list/all.json

1 „Gefällt mir“
16

Ich konnte nicht alle Benutzer über diesen Endpunkt abrufen. Gibt es dazu Erklärungen?

17

Eine weitere Lösung, die etwas umständlich ist, aber bei mir funktioniert:

/admin/users/list/active.json?show_emails=true&page=${page}
1 „Gefällt mir“
18

Die Verwendung des Flags „new

1 „Gefällt mir“
19

Nur für das Protokoll:

    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 „Gefällt mir“