Skip to Content

TwentyThree

TwentyThree™ API

API Method: /api/user/list

Get a list of users

Parameters

ParameterDescription
user_id Limit to a single user.
search Search users for a specific term.
orderby Variable to order users by.
Default: display_name
Valid values: username, site_admin_p, email, creation_date, last_login, display_name
order Order of the objects in the response.
Default: desc
Valid values: desc and asc
p Page offset for the request. See [pagination](index#pagination) for details.
size Number of objects to include in the response. See [pagination](index#pagination) for details.

Permission level

The minimum required permission level is:

anonymous

To get the properties email, full_name and site_admin the API requires:

admin

Example XML Response

<response status="ok" permission_level="admin" p="1" size="20" total_count="18" cached="0">
  <user user_id="1234" username="ernest" display_name="Ernest" 
    url="/user/ernest/" full_name="Ernest Hemmingway" email="ernest@example.com" site_admin="f">
    <about_abstract>Something about the user...</about_abstract>
  </user>
  (...)
</response>

Example JSON Response

{
  "status": "ok", 
  "permission_level":"anonymous",
  "cached":"0",
  "users":[
       {
         "user_id": "1234", 
         "username": "ernest", 
         "display_name": "Ernest", 
         "url": "/user/ernest/", 
         "about_abstract": "Something about the user"
       },
       ....],
  "p": "1",
  "size": "20",
  "total_count": "18",
  "site": {...},
  "endpoint": "/api/user/list"
}