Last modified 11:47, 15 Sep 2014


Returns the list of email contacts of the current user, from all the providers that support retrieving contacts. Contact information include first name, last name and email.


Supporting Providers

This operation is currently supported by the following providers: Google+, Yahoo.


  • Before your application can retrieve email contacts from providers, the user must grant your application access. During the social sign-on process, the user is presented with a dialog in which they authorize your application to retrieve contacts from their profile. For more information see the Enable retrieving user contacts guide. 
  • Please make sure you have checked the "Enable retrieving user contacts" check box in the Site settings page on Gigya's website (click the 'Advanced' button to open the collapsible configuration section).
  • Google+ application definitions must enable the Contacts API to retrieve user contacts (see the Google+ setup page for more information).



Request URL


Where <Data_Center_ID> is:

  • us1 - for the US datacenter
  • eu1 - for the European datacenter
  • au1 - for the Australian datacenter


Required Name Type Description
Required* UID string The unique ID of the user with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. See User.UID for more information.

Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.

Optional enabledProviders string A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers).
For example, if you would like the method to apply only to Facebook and Twitter, define: enabledProviders: "facebook, twitter".
Valid provider names include: 'googleplus', 'yahoo'.
  disabledProviders string A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which that you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers).
For example, if you would like the method to apply to all providers except Google+ and Twitter, define: disabledProviders: "googleplus, twitter".
Valid provider names include: 'googleplus', 'yahoo'.
  cid string A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
  format string Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
  • json
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
  • xml (default) - Deprecated. We do not support XML format anymore, but it is the default due to backwards compatibility. Please set the format parameter to either json or jsonp.
  callback string This parameter is relevant only when the format parameter is set to jsonp (see above). In such case this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
  httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if occurs.


Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Please refer to the Authorization Parameters section for details. 


Response Data

Field Type Description
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format. i.e
contacts JSON Array of Contact objects, corresponding to the list of contacts of the current user from all the email providers to which the user is connected.
providerErrorCodes JSON Array of provider-specific error objects. Each object includes the following fields (See the JSON example below):
  • provider
  • errorCode
  • errorMessage

Note: A field that does not contain data will not appear in the response.


Response Example

        "contacts": [{
            "email": "",
            "firstName": "Joe",
            "lastName": "Shmo",
            "nickname": "Jojo",
            "provider": "googleplus"
            "email": "",
            "firstName": "Bob",
            "lastName": "Cook",
            "provider": "Yahoo"

    "statusCode": 200,
    "errorCode": 0,
    "statusReason": "OK",
    "callId": "3353d2fbac894289977c102298df60d1"
    "providerErrorCodes": [{
            "provider": "yahoo",
            "errorCode": 0,
            "errorMessage": "OK"},
            "provider": "googleplus",
            "errorCode": 0,
            "errorMessage": "OK"}]
Page statistics
652 view(s) and 1 edit(s)
Social share
Share this page?


This page has no custom tags.
This page has no classifications.


You must to post a comment.