Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
External Contacts

Address Book Synchronization

Synchronizes user contacts.

get/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Query parameters

syncType'FSync' | 'ISync'

Type of synchronization

syncTokenstring

Value of syncToken property of the last sync request response

perPageinteger

Number of records per page to be returned. Max number of records is 250, which is also the default. For 'FSync' - if the number of records exceeds the parameter value (either specified or default), all of the pages can be retrieved in several requests. For 'ISync' - if the number of records exceeds page size, then the number of incoming changes to this number is limited

pageIdinteger

Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body

Response

Synchronized user contacts

uristring uri
nextPageIdinteger
nextPageUristring uri

Example response

{
  "records": [
    {
      "uri": "https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004",
      "email": "charlie.williams@example.com",
      "id": 623045004,
      "notes": "#1 Customer",
      "company": "Example, Inc.",
      "firstName": "Charlie",
      "lastName": "Williams",
      "jobTitle": "CEO",
      "webPage": "http://www.example.com",
      "middleName": "J",
      "nickName": "The Boss",
      "email2": "charlie-example@gmail.com",
      "email3": "theboss-example@hotmail.com",
      "homePhone": "+15551234567",
      "homePhone2": "+15551234567",
      "businessPhone": "+15551234567",
      "businessPhone2": "+15551234567",
      "mobilePhone": "+15551234567",
      "businessFax": "+15551234567",
      "companyPhone": "+15551234567",
      "assistantPhone": "+15551234567",
      "carPhone": "+15551234567",
      "otherPhone": "+15551234567",
      "otherFax": "+15551234567",
      "callbackPhone": "+15551234567",
      "businessAddress": {
        "street": "20 Davis Dr.",
        "city": "Belmont",
        "state": "CA",
        "zip": "94002"
      },
      "homeAddress": {
        "street": "20 Davis Dr.",
        "city": "Belmont",
        "state": "CA",
        "zip": "94002"
      },
      "otherAddress": {
        "street": "20 Davis Dr.",
        "city": "Belmont",
        "state": "CA",
        "zip": "94002"
      }
    }
  ]
}