RIringcentral
Internal Contacts

Get Corporate Directory Entry

Returns contact information on a particular corporate user of a federated account.

get/restapi/v1.0/account/{accountId}/directory/entries/{entryId}

Request

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)

entryIdstring required

Internal identifier of extension to read information for

Response

Contact information for given parameters. If value doesn't found then empty body will be returned

idstring 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

departmentstring
emailstring email
extensionNumberstring
firstNamestring

First name of a contact, for user extensions only

lastNamestring

Last name of a contact, for user extensions only

namestring

Name of a contact, for non-user extensions

jobTitlestring
hiddenboolean
subType'Unknown' | 'VideoPro' | 'VideoProPlus' | 'DigitalSignage' | 'Emergency'

Extension subtype

Example response

{
  "id": "865706371004",
  "type": "User",
  "status": "Enabled",
  "account": {
    "companyName": "My lovely company",
    "federatedName": "Lovely Holding",
    "id": "400131426008",
    "mainNumber": {
      "formattedPhoneNumber": "+1 (205) 6812029",
      "phoneNumber": "+12056812029",
      "type": "VoiceFax",
      "label": "Boss",
      "usageType": "DirectNumber"
    }
  },
  "department": "External",
  "email": "john.doe@mycompany.com",
  "extensionNumber": "103",
  "firstName": "John",
  "lastName": "Doe",
  "name": "Conference room ?5",
  "jobTitle": "Sales manager",
  "phoneNumbers": [
    {
      "formattedPhoneNumber": "+1 (205) 6812029",
      "phoneNumber": "+12056812029",
      "type": "VoiceFax",
      "label": "Boss",
      "usageType": "DirectNumber"
    }
  ],
  "profileImage": {
    "etag": "tag"
  },
  "site": {
    "id": "872781820006",
    "name": "Sales site",
    "code": "1007"
  },
  "callQueues": [
    {
      "id": "873014540006",
      "name": "Sales CQ"
    }
  ],
  "customFields": [
    {
      "id": "1032854",
      "name": "Rank",
      "value": "5"
    }
  ],
  "groups": [
    {
      "id": "63723034",
      "name": "Leaders"
    }
  ],
  "costCenter": {
    "id": "83266549237542",
    "code": "Main",
    "name": "Cost Center A"
  },
  "integration": {
    "id": "9813",
    "typeId": "1",
    "type": "External",
    "displayName": "Integration X",
    "routingType": "Account",
    "outboundEdgeId": "1726"
  },
  "subType": "Unknown"
}

Changes

No recorded changes to this operation across all 1 revision of this API.