---
title: "Get Company Directory Entries"
method: GET
path: "/restapi/v1.0/account/{accountId}/directory/entries"
tags: ["Internal Contacts"]
---

# Get Company Directory Entries

`GET /restapi/v1.0/account/{accountId}/directory/entries`

Returns contact information on corporate users of federated accounts. Please note: 1. `User`, `DigitalUser`, `VirtualUser` and `FaxUser` types are returned as `User` type. 2. `ApplicationExtension` type is not returned. 3. Only extensions in `Enabled`, `Disabled` and `NotActivated` state are returned.

## Path parameters

- `accountId` string, required

## Query parameters

- `showFederated` boolean
- `type` 'User' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'IvrMenu' | 'ParkLocation' | 'Limited' | 'External'
- `typeGroup` 'User' | 'NonUser'
- `page` integer
- `perPage` union
  - integer
  - 'max' | 'all'
- `siteId` string

## Headers

- `If-None-Match` string

## Response `200`

Paged collection of all contacts information for a given account. Records can be empty if no data found.

- DirectoryResource
  - `paging` EnumeratedPagingModel, required
    - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request.
    - `page` integer — The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)
    - `pageStart` integer — The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty
    - `pageEnd` integer — The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty
    - `totalPages` integer — The total number of pages in a dataset. May be omitted for some resources due to performance reasons
    - `totalElements` integer — The total number of elements in a dataset. May be omitted for some resource due to performance reasons
  - `records` ContactResource[], required
    - `id` string, required — Contact extension identifier
    - `type` 'User' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'IvrMenu' | 'Limited' | 'ApplicationExtension' | 'Site' | 'Bot' | 'Room' | 'ProxyAdmin' | 'DelegatedLinesGroup' | 'GroupCallPickup' | 'External' | 'RoomConnector' | 'Unknown' — Contact type
    - `status` 'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned' | 'Unknown' — Contact status
    - `account` AccountResource
      - `companyName` string
      - `federatedName` string
      - `id` string, required
      - `mainNumber` PhoneNumberResource
        - `formattedPhoneNumber` string
        - `phoneNumber` string
        - `type` string
        - `label` string — Custom user name of a phone number, if any
        - `usageType` 'MobileNumber' | 'ContactNumber' | 'DirectNumber' | 'ForwardedNumber' — Usage type of phone number
        - `hidden` boolean — Specifies if a phone number should be hidden or not
        - `primary` boolean — Specifies if the number is primary, i.e. displayed as 'main number' and called by default
    - `department` string
    - `email` string, email
    - `extensionNumber` string
    - `firstName` string — First name of a contact, for user extensions only
    - `lastName` string — Last name of a contact, for user extensions only
    - `name` string — Name of a contact, for non-user extensions
    - `jobTitle` string
    - `phoneNumbers` PhoneNumberResource[]
      - `formattedPhoneNumber` string
      - `phoneNumber` string
      - `type` string
      - `label` string — Custom user name of a phone number, if any
      - `usageType` 'MobileNumber' | 'ContactNumber' | 'DirectNumber' | 'ForwardedNumber' — Usage type of phone number
      - `hidden` boolean — Specifies if a phone number should be hidden or not
      - `primary` boolean — Specifies if the number is primary, i.e. displayed as 'main number' and called by default
    - `profileImage` AccountDirectoryProfileImageResource
      - `etag` string
      - `uri` string, uri
    - `site` BusinessSiteResource
      - `id` string
      - `name` string
      - `code` string
    - `hidden` boolean
    - `role` DirectoryRoleResource
      - `id` string, required
      - `name` string
      - `domain` string
      - `displayName` string
    - `callQueues` CallQueueResource[]
      - `id` string
      - `name` string
    - `customFields` CustomFieldResource[]
      - `id` string
      - `name` string
      - `value` string
    - `groups` GroupResource[]
      - `id` string
      - `name` string
    - `costCenter` CostCenterResource
      - `id` string
      - `code` string
      - `name` string
    - `integration` ExternalIntegrationResource
      - `id` string
      - `typeId` string
      - `type` string
      - `displayName` string
      - `routingType` string
      - `outboundEdgeId` string
    - `subType` 'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency' — Extension subtype

## Other responses

- `400` — Current request cannot be processed due to error in its body and/or url.
- `500` — Some unexpected error during current request processing.
- `503` — Network error during request

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)