Export It 1.3.1 Documentation

REST Server API: get_members

Returns a list of members

Resource URL

http://example.com/?ACT=<ACT>&key=<key>&method=get_members&format=xml

Parameters

group_id optional The user group you want to limit against
include_custom_fields optional Whether you want to include the custom fields with the return
complete_select optional Should the return include most data fields?
date_range optional Either the number of days from "today" or a range of 2 dates separated by "to"
keywords optional The keywords to search for members with.
perpage optional How many results do you want to return?
offset optional The offset to use for pagination.
order optional The order you'd like the results returned in based on.

Example Request

http://example.com/?ACT=<ACT>&key=<key>&method=get_members&format=xml&group_id=5&complete_select=1&include_custom_fields=1&perpage=2

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<members>
    <member>
        <member_id>830</member_id>
        <group_id>5</group_id>
        <username><![CDATA[tester@gmail.com]]></username>
        <screen_name><![CDATA[tester@gmail.com]]></screen_name>
        <remember_me><![CDATA[]]></remember_me>
        <authcode><![CDATA[FZ7WOSyyRI]]></authcode>
        <email><![CDATA[tester@gmail.com]]></email>
        <url><![CDATA[]]></url>
        <location><![CDATA[]]></location>
        <occupation><![CDATA[]]></occupation>
        <interests><![CDATA[]]></interests>
        <bday_d><![CDATA[]]></bday_d>
        <bday_m><![CDATA[]]></bday_m>
        <bday_y><![CDATA[]]></bday_y>
        <aol_im><![CDATA[]]></aol_im>
        <yahoo_im><![CDATA[]]></yahoo_im>
        <msn_im><![CDATA[]]></msn_im>
        <icq><![CDATA[]]></icq>
        <bio><![CDATA[]]></bio>
        <signature><![CDATA[]]></signature>
        <avatar_filename><![CDATA[]]></avatar_filename>
        <avatar_width><![CDATA[]]></avatar_width>
        <avatar_height><![CDATA[]]></avatar_height>
        <photo_filename><![CDATA[]]></photo_filename>
        <photo_width><![CDATA[]]></photo_width>
        <photo_height><![CDATA[]]></photo_height>
        <sig_img_filename><![CDATA[]]></sig_img_filename>
        <sig_img_width><![CDATA[]]></sig_img_width>
        <sig_img_height><![CDATA[]]></sig_img_height>
        <ignore_list><![CDATA[]]></ignore_list>
        <private_messages>0</private_messages>
        <accept_messages><![CDATA[y]]></accept_messages>
        <last_view_bulletins>0</last_view_bulletins>
        <last_bulletin_date>0</last_bulletin_date>
        <ip_address><![CDATA[127.0.0.1]]></ip_address>
        <join_date>1332764162</join_date>
        <last_visit>0</last_visit>
        <last_activity>0</last_activity>
        <total_entries>4</total_entries>
        <total_comments>0</total_comments>
        <total_forum_topics>0</total_forum_topics>
        <total_forum_posts>0</total_forum_posts>
        <last_entry_date>0</last_entry_date>
        <last_comment_date>0</last_comment_date>
        <last_forum_post_date>0</last_forum_post_date>
        <last_email_date>0</last_email_date>
        <in_authorlist><![CDATA[n]]></in_authorlist>
        <accept_admin_email><![CDATA[y]]></accept_admin_email>
        <accept_user_email><![CDATA[y]]></accept_user_email>
        <notify_by_default><![CDATA[y]]></notify_by_default>
        <notify_of_pm><![CDATA[y]]></notify_of_pm>
        <display_avatars><![CDATA[y]]></display_avatars>
        <display_signatures><![CDATA[y]]></display_signatures>
        <parse_smileys><![CDATA[y]]></parse_smileys>
        <smart_notifications><![CDATA[y]]></smart_notifications>
        <language><![CDATA[deutsch]]></language>
        <timezone><![CDATA[UM8]]></timezone>
        <daylight_savings><![CDATA[y]]></daylight_savings>
        <localization_is_site_default><![CDATA[n]]></localization_is_site_default>
        <time_format><![CDATA[us]]></time_format>
        <cp_theme><![CDATA[]]></cp_theme>
        <profile_theme><![CDATA[]]></profile_theme>
        <forum_theme><![CDATA[]]></forum_theme>
        <tracker><![CDATA[]]></tracker>
        <template_size>20</template_size>
        <notepad><![CDATA[]]></notepad>
        <notepad_size>18</notepad_size>
        <quick_links><![CDATA[]]></quick_links>
        <quick_tabs><![CDATA[]]></quick_tabs>
        <pmember_id>0</pmember_id>
        <group_title><![CDATA[Members]]></group_title>
        <first_name><![CDATA[Tester]]></first_name>
        <last_name><![CDATA[Testerson]]></last_name>
        <address><![CDATA[]]></address>
        <address2><![CDATA[]]></address2>
        <city><![CDATA[]]></city>
        <state><![CDATA[]]></state>
        <zip><![CDATA[]]></zip>
        <country><![CDATA[]]></country>
        <country_code><![CDATA[]]></country_code>
        <company><![CDATA[]]></company>
        <phone><![CDATA[]]></phone>
    </member>
    <member>
        <member_id>834</member_id>
        <group_id>5</group_id>
        <username><![CDATA[test@gmail.com]]></username>
        <screen_name><![CDATA[test@gmail.com]]></screen_name>
        <salt><![CDATA[]]></salt>
        <unique_id><![CDATA[blah]]></unique_id>
        <remember_me><![CDATA[]]></remember_me>
        <crypt_key><![CDATA[]]></crypt_key>
        <authcode><![CDATA[PoqO5Lxsmw]]></authcode>
        <email><![CDATA[test@gmail.com]]></email>
        <url><![CDATA[]]></url>
        <location><![CDATA[]]></location>
        <occupation><![CDATA[]]></occupation>
        <interests><![CDATA[]]></interests>
        <bday_d><![CDATA[]]></bday_d>
        <bday_m><![CDATA[]]></bday_m>
        <bday_y><![CDATA[]]></bday_y>
        <aol_im><![CDATA[]]></aol_im>
        <yahoo_im><![CDATA[]]></yahoo_im>
        <msn_im><![CDATA[]]></msn_im>
        <icq><![CDATA[]]></icq>
        <bio><![CDATA[]]></bio>
        <signature><![CDATA[]]></signature>
        <avatar_filename><![CDATA[]]></avatar_filename>
        <avatar_width><![CDATA[]]></avatar_width>
        <avatar_height><![CDATA[]]></avatar_height>
        <photo_filename><![CDATA[]]></photo_filename>
        <photo_width><![CDATA[]]></photo_width>
        <photo_height><![CDATA[]]></photo_height>
        <sig_img_filename><![CDATA[]]></sig_img_filename>
        <sig_img_width><![CDATA[]]></sig_img_width>
        <sig_img_height><![CDATA[]]></sig_img_height>
        <ignore_list><![CDATA[]]></ignore_list>
        <private_messages>0</private_messages>
        <accept_messages><![CDATA[y]]></accept_messages>
        <last_view_bulletins>0</last_view_bulletins>
        <last_bulletin_date>0</last_bulletin_date>
        <ip_address><![CDATA[127.0.0.1]]></ip_address>
        <join_date>1332764162</join_date>
        <last_visit>0</last_visit>
        <last_activity>0</last_activity>
        <total_entries>4</total_entries>
        <total_comments>0</total_comments>
        <total_forum_topics>0</total_forum_topics>
        <total_forum_posts>0</total_forum_posts>
        <last_entry_date>0</last_entry_date>
        <last_comment_date>0</last_comment_date>
        <last_forum_post_date>0</last_forum_post_date>
        <last_email_date>0</last_email_date>
        <in_authorlist><![CDATA[n]]></in_authorlist>
        <accept_admin_email><![CDATA[y]]></accept_admin_email>
        <accept_user_email><![CDATA[y]]></accept_user_email>
        <notify_by_default><![CDATA[y]]></notify_by_default>
        <notify_of_pm><![CDATA[y]]></notify_of_pm>
        <display_avatars><![CDATA[y]]></display_avatars>
        <display_signatures><![CDATA[y]]></display_signatures>
        <parse_smileys><![CDATA[y]]></parse_smileys>
        <smart_notifications><![CDATA[y]]></smart_notifications>
        <language><![CDATA[deutsch]]></language>
        <timezone><![CDATA[UM8]]></timezone>
        <daylight_savings><![CDATA[y]]></daylight_savings>
        <localization_is_site_default><![CDATA[n]]></localization_is_site_default>
        <time_format><![CDATA[us]]></time_format>
        <cp_theme><![CDATA[]]></cp_theme>
        <profile_theme><![CDATA[]]></profile_theme>
        <forum_theme><![CDATA[]]></forum_theme>
        <tracker><![CDATA[]]></tracker>
        <template_size>20</template_size>
        <notepad><![CDATA[]]></notepad>
        <notepad_size>18</notepad_size>
        <quick_links><![CDATA[]]></quick_links>
        <quick_tabs><![CDATA[]]></quick_tabs>
        <show_sidebar><![CDATA[n]]></show_sidebar>
        <pmember_id>0</pmember_id>
        <group_title><![CDATA[Members]]></group_title>
        <first_name><![CDATA[Ben]]></first_name>
        <last_name><![CDATA[Foo]]></last_name>
        <address><![CDATA[12345 Fake St.]]></address>
        <address2><![CDATA[]]></address2>
        <city><![CDATA[Los Angeles]]></city>
        <state><![CDATA[CA]]></state>
        <zip>90024</zip>
        <country><![CDATA[USA]]></country>
        <country_code><![CDATA[]]></country_code>
        <company><![CDATA[]]></company>
        <phone><![CDATA[555-555-5555]]></phone>
    </member>
</members>
Flag
I am flagging this documentation as:

Need Free Developer Support?

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre lang="" line="" escaped="" highlight="">