RIringcentral
Internal Contacts

Get Account Federation

Returns information on a federation and associated accounts.

get/restapi/v1.0/account/{accountId}/directory/federation

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)

Query parameters

types'All' | 'Regular' | 'AdminOnly'

Federation types for search

Filter by federation types. Default is Regular

Headers

RCExtensionIdstring

RingCentral extension id

Response

List of found federations. Records array can be empty if no data found

creationTimestring date-time
displayNamestring
idstring
lastModifiedTimestring date-time
type'Regular' | 'AdminOnly'

Federation type

Example response

{
  "accounts": [
    {
      "mainNumber": {
        "formattedPhoneNumber": "+1 (205) 6812029",
        "phoneNumber": "+12056812029",
        "type": "VoiceFax",
        "label": "Boss",
        "usageType": "DirectNumber"
      }
    }
  ]
}

Changes

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