---
title: "List account links"
method: GET
path: "/account-links"
tags: ["Account Links"]
---

# List account links

`GET /account-links`

## Request

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

## Query parameters

- `platform` Platform[]: Repeat the key to match any of several.
- `status` string[]: Repeat the key to match any of several.
- `limit` integer: Page size, from 1 to 100. Defaults to 50.
- `cursor` string: The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for.

## Response `200`

OK

- AccountLinkPage: Ordered by `createdAt`, oldest first.
  - `data` AccountLink[], required
    - `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
  - `nextCursor` string, nullable, required: Pass it back as `cursor`, with the same filters, to read the next page. Null on the last page.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `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)