---
title: "Get Account Federation"
method: GET
path: "/restapi/v1.0/account/{accountId}/directory/federation"
tags: ["Internal Contacts"]
---

# Get Account Federation

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

Returns information on a federation and associated accounts.

## Path parameters

- `accountId` string, required

## Query parameters

- `types` 'All' | 'Regular' | 'AdminOnly' — Federation types for search

## Headers

- `RCExtensionId` string

## Response `200`

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

- FederationResource
  - `accounts` FederatedAccountResource[]
    - `companyName` string
    - `conflictCount` integer
    - `federatedName` string
    - `id` string, required
    - `linkCreationTime` string, date-time
    - `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
  - `creationTime` string, date-time
  - `displayName` string
  - `id` string
  - `lastModifiedTime` string, date-time
  - `type` 'Regular' | 'AdminOnly' — Federation type

## 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)