Friends.get
From Facebook Developer Wiki
Contents |
Description
Returns the Facebook user IDs of the current user's Facebook friends. The current user is determined from the session_key parameter. The values returned from this call are not storable.
You can call this method without a session key to return a list of friends of a user on your application's canvas page. The user must have authorized your application in order to make this call without a session key. This is similar to how Facebook passes the UIDs of friends of a user on your application's canvas page.
Parameters
| Required | Name | Type | Description | |
| 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. | |
|---|---|---|---|---|
| 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 | session_key | string | The session key of the logged in user. The session key is automatically included by our PHP client. | |
| 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. | ||
| flid | int | Returns the friends in a friend list. | ||
| uid | int | The user ID for the user whose friends you want to return. Specify the uid when calling this method without a session key. |
Response
Privacy Note: The friend IDs returned are the friends that are visible to the Facebook Platform. If no friends are found, the method returns an empty friends_get_response element.
Example Return XML
Example Return JSON
FQL Equivalent
FQL queries take the form: SELECT <fields> FROM <table> WHERE <conditions>
This function is similar (but returned in a slightly different format) to doing the following FQL query, with the appropriate parameters filled in:
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. | |
| 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
- This function does not require a
session_key, unless it is being called by a desktop application. - You can call this method using a session secret, and not the application secret (for example, for a Facebook Connect site or desktop application).
