ConnectCloud Developers

List the employee's accounts in NFON and TeamViewer (hr:write)

GET /api/hr/v1/employees/{id}/linked-accounts

Module: HR · operationId: listEmployeeLinkedAccounts · Tag: Employees · Auth: access token (Authorization: Bearer <accessToken>)

The accounts comms links to the employee's e-mail (ADR 0039: comms keeps the links, HR decides who sees and changes them) and the providers that know accounts. TeamViewer accounts are learned by comms from the TeamViewer user's e-mail (learned); a person corrects them here. An employee without e-mail has none.

Parameters

Name In Type Required Description
id path string (uuid) yes

Responses

  • 200 Linked accounts (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)
  • 503 comms is not configured or not reachable (linked_accounts_unavailable) (application/json)

Fields of the 200 answer:

  • items (array of LinkedAccount, required): Linked accounts of the employee
    • key (string, required): The provider's id of the account (NFON extension, TeamViewer user id)
    • learned (boolean, required): comms linked it by itself (TeamViewer e-mail); false: a person set it
    • provider (string, required): The provider of the account (one of nfon, teamviewer)
    • updatedAt (string (date-time), required): When the link was last set
    • label (string): The account's name in the provider, when known
  • providers (array of LinkedAccountProvider, required): The providers and what they offer
    • candidates (boolean, required): The provider's accounts can be listed to pick from (listLinkedAccountCandidates)
    • connected (boolean, required): The tenant connected the provider in comms (Settings › Integrations)
    • provider (string, required): The provider (one of nfon, teamviewer)

Example 200 answer:

{
  "items": [
    {
      "key": "217",
      "label": "Sophie Huber",
      "learned": false,
      "provider": "nfon",
      "updatedAt": "2026-10-05T10:12:00Z"
    },
    {
      "key": "u98765432",
      "label": "Sophie Huber",
      "learned": true,
      "provider": "teamviewer",
      "updatedAt": "2026-10-07T14:31:00Z"
    }
  ],
  "providers": [
    {
      "candidates": true,
      "connected": true,
      "provider": "nfon"
    },
    {
      "candidates": true,
      "connected": true,
      "provider": "teamviewer"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/employees/3f2b8c1e-7d4a-4e9b-9c2a-5b1d6e8f0a12/linked-accounts' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI