Groups.get

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Returns all visible groups according to the filters specified. You can use this method to return all groups associated with a user, or query a specific set of groups by a list of GIDs.

If both the uid and gids parameters are provided, the method returns all groups in the set of gids with which the user is associated. If the gids parameter is omitted, the method returns all groups associated with the provided user.

However, if the uid parameter is omitted, the method returns all groups associated with the provided gids, regardless of any user relationship.

If both parameters are omitted, the method returns all groups of the session user.

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call.
session_key string The session key of the logged in user. The session key is automatically included by our PHP client.
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. If you specify the call ID in your client, you don't need to pass it with every call.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically.
v string This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call.
optional format string The desired response format, which can be either XML or JSON. (Default value is XML.)
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.
gids string Filter by this list of group IDs. This is a comma-separated list of GIDs.
uid int Filter by groups associated with a user with this UID.

Response

Groups are only visible via the API if the user can see them on Facebook. A secret group is only visible to members of that group. If no visible groups are found, the method returns an empty groups_get_response element. The nid field will be 0 for global groups.

Note the following size constraints on photos returned:

  • pic - URL of group photo, with max width 100px and max height 300px. May be blank.
  • pic_big - URL of group photo, with max width 200px and max height 600px. May be blank.
  • pic_small - URL of group photo, with with max width 50px and max height 150px. May be blank.

Privacy note: Group creators are visible to an application only if the creator has not turned off access to the Platform or used the application; if the creator has opted out, the creator element appears in the following format:

<creator xsi:nil="true"/>

Note that this behavior is very similar to that exhibited by events.get.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <groups_get_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"> <group> <gid>2206609142</gid> <name>Donald Knuth Is My Homeboy</name> <nid>0</nid> <description>Donald Ervin Knuth (born January 10, 1938) is a renowned computer scientist and professor emeritus at Stanford University. Knuth is best known as the author of the multi-volume The Art of Computer Programming, one of the most highly respected references in the computer science field. He practically created the field of rigorous analysis of algorithms, and made many seminal contributions to several branches of theoretical computer science. He is also the creator of the TeX typesetting system and of the METAFONT font design system, and pioneered the concept of literate programming. That's how he ROLLS, y0.</description> <group_type>Just for Fun</group_type> <group_subtype>Fan Clubs</group_subtype> <recent_news/> <pic>http://photos-142.facebook.com/ip006/object/543/95/s2206609142_32530.jpg</pic> <pic_big>http://photos-142.facebook.com/ip006/object/543/95/n2206609142_32530.jpg</pic> <pic_small>http://photos-142.facebook.com/ip006/object/543/95/t2206609142_32530.jpg</pic> <creator>1240077</creator> <update_time>1156543965</update_time> <office/> <website/> <venue> <street/> <city/> <state>CA</state> <country>United States</country> </venue> </group> </groups_get_response>

FQL Equivalent

FQL queries take the form: SELECT <fields> FROM <table> WHERE <conditions>

This function is similar to doing the following FQL query, with the appropriate parameters filled in:

SELECT gid, name, nid, description, group_type, group_subtype, recent_news, pic, pic_big, pic_small, creator, update_time, office, website, venue FROM group WHERE gid IN (SELECT gid FROM group_member WHERE uid=uid) AND gid IN (gids)

Error Codes

CodeDescription
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.

Notes

You can call this method using a session secret, and not the application secret (for example, for a Facebook Connect site or desktop application).

Retrieved from "http://wiki.developers.facebook.com/index.php/Groups.get"
reference