Groups.getMembers

From Facebook Developers Wiki

Contents 1 Description 2 Parameters 3 Example Return XML 4 Response 5 FQL Equivalent 6 Error Codes

[edit] Description

Returns membership list data associated with a group.

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The application key associated with the calling application.
	session_key	string	The session key of the logged in user.
	call_id	float	The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function.
	sig	string	An MD5 hash of the current request and your secret key, as described in the authentication guide.
	v	string	This must be set to 1.0 to use this version of the API.
	gid	int	Group ID for which to retrieve member list.
optional	format	string	Desired response format. Either XML (default) or JSON.
	callback	string	Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <groups_getMembers_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true"> <members list="true"> <uid>1240077</uid> <uid>1240078</uid> <uid>222332</uid> <uid>222333</uid> </members> <admins list="true"> <uid>1240077</uid> <uid>222333</uid> </admins> <officers list="true"> <uid>1240078</uid> </officers> <not_replied list="true"/> </groups_getMembers_response>

[edit] Response

This method returns four (possibly empty) lists of users associated with a group, keyed on their associations (membership status). The members list contains the officers and admins lists, but does not overlap with the not_replied list.

Privacy Note: The lists can contain user IDs of users not using the calling application.

[edit] FQL Equivalent

This function is similar to doing the following FQL query, including the appropriate parameters:

SELECT uid, gid, positions FROM group_member WHERE gid=gid

[edit] Error Codes

Code	Description
1	An unknown error occurred. Please resubmit the request.
2	The service is not available at this time.
4	The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5	The request came from a remote address not allowed by this application.
100	One of the parameters specified was missing or invalid.
101	The API key submitted is not associated with any known application.
102	The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103	The submitted call_id was not greater than the previous call_id for this session.
104	Incorrect signature.