---
title: "List Contacts"
method: GET
path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact"
tags: ["External Contacts"]
---

# List Contacts

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

## Request

- Base URL: `https://platform.ringcentral.com`
- URL: `https://platform.ringcentral.com/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact`
- Auth: OAuth 2
  - Authorization code: `https://platform.ringcentral.com/restapi/oauth/authorize`
  - Token URL: `https://platform.ringcentral.com/restapi/oauth/token`
- TypeScript: <https://skmtc.dev/ringcentral/apis/ringcentral-api/docs/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the user personal contacts.

## Path parameters

- `accountId` string, required
- `extensionId` string, required

## Query parameters

- `startsWith` string
- `sortBy` string[]
- `page` integer
- `perPage` integer
- `phoneNumber` string[]

## Response `200`

Contact list

- ContactList
  - `uri` string, uri: Link to the list of user personal contacts
  - `records` PersonalContactResource[]: List of personal contacts from the extension address book
    - `uri` string, uri: Canonical URI of a contact
    - `availability` 'Alive' | 'Deleted' | 'Purged': This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`
    - `email` string, email: Email of a contact
    - `id` integer: Internal identifier of availability contact
    - `notes` string: Notes for a contact
    - `company` string: Company name of a contact
    - `firstName` string: First name of a contact
    - `lastName` string: Last name of a contact
    - `jobTitle` string: Job title of a contact
    - `birthday` string, date-time: Date of birth of a contact
    - `webPage` string, uri: The contact home page URL
    - `middleName` string: Middle name of a contact
    - `nickName` string: Nick name of a contact
    - `email2` string, email: Second email of a contact
    - `email3` string, email: Third email of a contact
    - `homePhone` string: Home phone number of a contact in e.164 (with "+") format
    - `homePhone2` string: Second home phone number of a contact in e.164 (with "+") format
    - `businessPhone` string: Business phone of the contact in e.164 (with "+") format
    - `businessPhone2` string: Second business phone of a contact in e.164 (with "+") format
    - `mobilePhone` string: Mobile phone of a contact in e.164 (with "+") format
    - `businessFax` string: Business fax number of a contact in e.164 (with "+") format
    - `companyPhone` string: Company number of a contact in e.164 (with "+") format
    - `assistantPhone` string: Phone number of a contact assistant in e.164 (with "+") format
    - `carPhone` string: Car phone number of a contact in e.164 (with "+") format
    - `otherPhone` string: Other phone number of a contact in e.164 (with "+") format
    - `otherFax` string: Other fax number of a contact in e.164 (with "+") format
    - `callbackPhone` string: Callback phone number of a contact in e.164 (with "+") format
    - `businessAddress` ContactAddressInfo
      - `street` string: Street address
      - `city` string: City name
      - `country` string: Country name
      - `state` string: State/province name
      - `zip` string: Zip/Postal code
    - `homeAddress` ContactAddressInfo
      - `street` string: Street address
      - `city` string: City name
      - `country` string: Country name
      - `state` string: State/province name
      - `zip` string: Zip/Postal code
    - `otherAddress` ContactAddressInfo
      - `street` string: Street address
      - `city` string: City name
      - `country` string: Country name
      - `state` string: State/province name
      - `zip` string: Zip/Postal code
    - `ringtoneIndex` string: Contact ringtone. Max number of symbols is 64
  - `navigation` UserContactsNavigationInfo: Information on navigation
    - `firstPage` UserContactsNavigationInfoUri: Canonical URI for a corresponding page of a list
      - `uri` string, uri
    - `nextPage` UserContactsNavigationInfoUri: Canonical URI for a corresponding page of a list
      - `uri` string, uri
    - `previousPage` UserContactsNavigationInfoUri: Canonical URI for a corresponding page of a list
      - `uri` string, uri
    - `lastPage` UserContactsNavigationInfoUri: Canonical URI for a corresponding page of a list
      - `uri` string, uri
  - `paging` UserContactsPagingInfo: Information on paging
    - `page` integer: Current page number. 1-indexed, so the first page is 1 by default. May be omitted if the result is empty (because non-existent page was specified or perPage=0 was requested)
    - `perPage` integer: Current page size, describes how many items each page contains. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied
    - `pageStart` integer: Zero-based number of the first element on the current page. Omitted if a page is omitted or the result is empty
    - `pageEnd` integer: Zero-based index of the last element on the current page. Omitted if a page is omitted or the result is empty
    - `totalPages` integer: Total number of pages in a dataset. May be omitted for some resources due to performance reasons
    - `totalElements` integer: Total number of elements in a dataset. May be omitted for some resource due to performance reasons
  - `groups` UserContactsGroupsInfo: Information on address book groups
    - `uri` string, uri: Link to the list of address book groups

---

[API](https://skmtc.dev/ringcentral/apis/ringcentral-api.md) - [All operations](https://skmtc.dev/ringcentral/apis/ringcentral-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ringcentral/apis/ringcentral-api/revisions/8d602198ec97?raw)