Skip to main content
GET
Get account link

Path Parameters

Pattern: ^[0-9a-z]+$

Response

A platform account the team connected to Inboxapp. Every conversation and message goes through one.

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; a team may have others enabled.

Example:

"twitter"

platformId
string
required

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

username
string | null
required

The platform username without its display prefix. Lookups take this form.

Example:

"jane"

displayName
string | null
required
avatarUrl
string | null
required
status
enum<string>
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.

Available options:
active,
offline,
paused
pauseReasons
string[]
required

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

Examples:
capabilities
enum<string>[]
required

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

Available options:
message:send,
message:edit,
message:delete:self,
message:unsend,
message:react,
message:reply,
message:forward,
media:image,
media:video,
media:gif,
media:file,
media:audio,
thread:typing:send,
thread:typing:receive,
thread:message-requests,
thread:delete:remote,
directory:typeahead,
thread:archive:observe,
thread:archive:mutate,
thread:read:observe,
thread:read:mutate,
profile:follow,
profile:unfollow
syncedAt
string<date-time> | null
required

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

Example:

"2026-09-14T10:32:00.000Z"

createdAt
string<date-time>
required
Example:

"2026-09-14T10:32:00.000Z"