Friends.getLists

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Returns the names and identifiers of any friend lists that the user has created. The current user is determined from the session_key parameter.

The values returned from this call are storable. You can store the ID of a friend list that the user has elected for use in some feature of your application, but you should verify the ID periodically, as users may delete or modify lists at any time. Friend lists are private on Facebook, so you cannot republish this information to anyone other than the logged in user. Members of lists may be obtained using friends.get with an flid parameter.

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, or the session key provided when the user granted your application the offline_access extended permission. 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.

Response

The friend list IDs returned are the lists associated with the subject user.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <friends_getLists_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"> <friendlist> <flid>524434806283</flid> <name>sample list</name> </friendlist> <friendlist> <flid>524434806284</flid> <name>another sample</name> </friendlist> </friends_getLists_response>

Example Return JSON

[{"flid":524434806284,"name":"another sample"},{"flid":524434806283,"name":"sample list"}]

FQL Equivalent

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

SELECT flid, name FROM friendlist WHERE owner=uid

Error Codes

For a complete list of error codes, see 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.
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/Friends.getLists"