API Methods: users.getList

Description

Returns a list of site users.


API Version

Version 1&2

Required parameters

  • None

Optional parameters

  • user_id - can also be a comma separated list of multiple user ids
  • username
  • email_address
  • last_login
  • date_joined
  • tier
  • featured
  • most_recent
  • ss_key
  • interest_key
  • subinterest_key
  • has_photos - if set to true, returns only users with photos
  • show_all - if set to true, returns inactive users as well

Example response

<?xml version="1.0"?>
<response status="ok" time="Tue, 22 Apr 2008 16:43:59 -0500">
    <users count="2" total="31">
        <user>
            <user_id>29</user_id>
            <username>
                <![CDATA[Bob Smith]]>
            </username>
            <email_address>
                <![CDATA[bob@example.com]]>
            </email_address>
            <last_login>1207683694</last_login>
            <date_joined>
                <![CDATA[2008-04-08 19:41:14]]>
            </date_joined>
            <status>1</status>
            <thumb_link/>
            <tier>0</tier>
        </user>
        <user>
            <user_id>28</user_id>
            <username>
                <![CDATA[Alice Jones]]>
            </username>
            <email_address>
                <![CDATA[ajones@example.com]]>
            </email_address>
            <last_login>1206399214</last_login>
            <date_joined>
                <![CDATA[2008-03-24 22:52:04]]>
            </date_joined>
            <status>-1</status>
            <thumb_link/>
            <tier>0</tier>
        </user>
    </users>
</response>