---
title: "Get account link"
method: GET
path: "/account-links/{accountLinkId}"
tags: ["Account Links"]
---

# Get account link

`GET /account-links/{accountLinkId}`

## Request

- Base URL: `https://inboxapp.com/api/v2`
- URL: `https://inboxapp.com/api/v2/account-links/{accountLinkId}`
- Auth: HTTP bearer

## Path parameters

- `accountLinkId` string, required

## Response `200`

OK

- AccountLink: A platform account the team connected to Inboxapp. Every conversation and message goes through one.
  - `id` string, required
  - `platform` string, required: The platform. Every team can use twitter, linkedin; a team may have others enabled.
  - `platformId` string, required: The ID the platform gives this object. Only meaningful next to its `platform`.
  - `username` string, nullable, required: The platform username, without a display prefix such as `@`.
  - `displayName` string, nullable, required
  - `avatarUrl` string, nullable, required
  - `status` 'active' | 'offline' | 'paused', required: `active` sends and syncs. `paused` is stopped for the reasons in `pauseReasons`, and resumes once none remain. `offline` lost its connection to the platform and must be reconnected in Inboxapp.
  - `pauseReasons` string[], required: Why the account link is paused. New reasons may be added.
  - `capabilities` string[], required: What this account can do: its platform's capabilities, narrowed for this account. An operation it lacks fails with `capabilityNotSupported`.
  - `syncedAt` string, date-time, nullable, required: When Inboxapp finished importing the account's conversations. Null until then.
  - `createdAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/inboxapp/apis/inboxapp-api.md) · [All operations](https://skmtc.dev/inboxapp/apis/inboxapp-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inboxapp/apis/inboxapp-api/revisions/7f9bbf45e851?raw)