v1

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

External Contacts

List Contacts

Returns the user personal contacts.

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

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

startsWithstring

If specified, only contacts which 'First name' or 'Last name' start with the mentioned substring will be returned. Case-insensitive

sortBystring[]

Sorts results by the specified property

pageinteger

The result set page number (1-indexed) to return

perPageinteger

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied

phoneNumberstring[]

Phone number in e.164 format

Response

Contact list

uristring uri

Link to the list of user personal contacts

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"
      }
    }
  ]
}