Admin

List users by flag

GET

https://discourse.example.com/admin/users/list/{flag}.json

List users by flag

curl -X GET 'https://discourse.example.com/admin/users/list/active.json'

const response = await fetch('https://discourse.example.com/admin/users/list/active.json', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/admin/users/list/active.json')
print(response.text)

200

[
  {
    "id": 0,
    "username": "string",
    "name": "string",
    "avatar_template": "string",
    "email": "string",
    "secondary_emails": [],
    "active": true,
    "admin": true,
    "moderator": true,
    "last_seen_at": "string",
    "last_emailed_at": "string",
    "created_at": "string",
    "last_seen_age": 0,
    "last_emailed_age": 0,
    "created_at_age": 0,
    "trust_level": 0,
    "manual_locked_trust_level": "string",
    "title": "string",
    "time_read": 0,
    "staged": true,
    "days_visited": 0,
    "posts_read_count": 0,
    "topics_entered": 0,
    "post_count": 0
  }
]

Parameters

flagstringactivenewstaffsuspendedblockedsuspectrequiredpath

orderstringcreatedlast_emailedseenusernameemailtrust_leveldays_visitedposts_readtopics_viewedpostsread_timequery

ascstringtruequery

pageintegerquery

show_emailsbooleanquery

Include user email addresses in response. These requests will be logged in the staff action logs.

statsbooleanquery

Include user stats information

emailstringquery

Filter to the user with this email address

ipstringquery

Filter to users with this IP address

Response

200OKArray<object>

response

Response fields application/json

Array<object>

Show child attributes

idintegerrequired

usernamestringrequired

namestring | nullrequired

avatar_templatestringrequired

emailstring

secondary_emailsArray<any>

activebooleanrequired

adminbooleanrequired

moderatorbooleanrequired

last_seen_atstring | nullrequired

last_emailed_atstring | nullrequired

created_atstringrequired

last_seen_agenumber | nullrequired

last_emailed_agenumber | nullrequired

created_at_agenumber | nullrequired

trust_levelintegerrequired

manual_locked_trust_levelstring | nullrequired

titlestring | nullrequired

time_readintegerrequired

stagedbooleanrequired

days_visitedintegerrequired

posts_read_countintegerrequired

topics_enteredintegerrequired

post_countintegerrequired

Docs by Sourcey