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

accountLinkIdstring required

Response

OK

idstring required
platformstring required

The platform. Every team can use twitter, linkedin; a team may have others enabled.

platformIdstring required

The ID the platform gives this object. Only meaningful next to its platform.

usernamestring nullable required

The platform username, without a display prefix such as @.

displayNamestring nullable required
avatarUrlstring 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.

pauseReasonsstring[] required

Why the account link is paused. New reasons may be added.

capabilitiesstring[] required

What this account can do: its platform's capabilities, narrowed for this account. An operation it lacks fails with capabilityNotSupported.

syncedAtstring date-time nullable required

When Inboxapp finished importing the account's conversations. Null until then.

createdAtstring date-time required

Example response

{
  "platform": "twitter",
  "username": "jane",
  "pauseReasons": [
    "billing"
  ],
  "syncedAt": "2026-09-14T10:32:00.000Z",
  "createdAt": "2026-09-14T10:32:00.000Z"
}

Changes

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