Skip to main content
GET
/
account-links
List account links
curl --request GET \
  --url https://inboxapp.com/api/v1/account-links \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "platform": "twitter",
    "platformId": "<string>",
    "name": "<string>",
    "username": "<string>",
    "image": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "status": "active",
    "syncedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

OK

​
id
string
required

The Inbox ID of the account link.

Example:

"df6jbw4h36..."

​
platform
enum<string>
required
Available options:
twitter,
sandbox
​
platformId
string
required

The platform ID of the account link.

Example:

"1234567890"

​
name
string
required
Example:

"Acme Agency"

​
username
string
required
Example:

"acme_agency"

​
image
string
required
Example:

"https://example.com/image.png"

​
createdAt
string<date-time>
required
​
status
enum<string>
required

X may periodically sign out your account, in which case it will be marked as offline. An account can get paused if the team is scheduled for deletion or in other circumstances, and is a far less common state that has nothing to do with the X API.

Available options:
active,
offline,
paused
Example:

"active"

​
syncedAt
string<date-time> | null
required

When this account was completely synced for the first time.