Skip to main content
GET
/
v1
/
accounts
List Accounts
curl --request GET \
  --url https://api.lobstr.io/v1/accounts \
  --header 'Authorization: <authorization>'
{
  "total_results": 123,
  "limit": 123,
  "page": 123,
  "total_pages": 123,
  "result_from": 123,
  "result_to": 123,
  "data": [
    {}
  ],
  "next": {},
  "previous": {},
  "id": "<string>",
  "object": "<string>",
  "username": "<string>",
  "created_at": "<string>",
  "last_synchronization_time": "<string>",
  "status": "<string>",
  "status_code_info": "<string>",
  "status_code_description": "<string>",
  "type": "<string>",
  "params": {},
  "updated_at": {},
  "account_type_hash": "<string>",
  "squids": [
    {}
  ],
  "baseurl": "<string>",
  "cookies": [
    {}
  ],
  "icon": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves a paginated list of all connected platform accounts (like Twitter, LinkedIn, Facebook) associated with the authenticated user.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Response Structure

​
total_results
integer
Total number of accounts. Example: 2
​
limit
integer
Maximum results per page. Example: 50
​
page
integer
Current page number. Example: 1
​
total_pages
integer
Total number of pages. Example: 1
​
result_from
integer
Starting result index. Example: 1
​
result_to
integer
Ending result index. Example: 3
​
data
array
Array of account objects. Example: [...]
​
next
string | null
URL for next page (null if last page). Example: null
​
previous
string | null
URL for previous page (null if first page). Example: null

​
Account Object Fields

​
id
string
Unique account identifier. Example: "6e5f36d27502ec69fda745ec59ead509"
​
object
string
Always “account”. Example: "account"
​
username
string
Platform username. Example: "MisterDebugger"
​
created_at
string
Account creation timestamp (ISO 8601). Example: "2025-02-11T08:28:14Z"
​
last_synchronization_time
string
Last sync timestamp. Example: "2025-02-11T08:28:14Z"
​
status
string
HTTP status code. Example: "200"
​
status_code_info
string
Status information. Example: "synchronized"
​
status_code_description
string
Human-readable status message. Example: "Success!"
​
type
string
Account type identifier. Example: "facebook-sync"
​
params
object
Account parameters (default and user-specific). Example: {"default": {}, "user": {}}
​
updated_at
string | null
Last update timestamp. Example: null
​
account_type_hash
string
Account type identifier hash. Example: "16f5b7f91e8fc533eab88be973273a02"
​
squids
array
Array of squids using this account. Example: []
​
baseurl
string
Platform base URL. Example: "https://www.facebook.com"
​
cookies
array
Required cookie names for authentication. Example: [{"name": "c_user", "required": true}]
​
icon
string
Base64 encoded platform icon. Example: "<base64 image data>"
Use this endpoint to check which platform accounts are currently synced and their status before running squids that require authentication.
The squids array shows which squids are currently using each account, helping you manage account usage across your projects.
Check the status_code_info field to identify accounts with expired cookies that need re-synchronization.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/accounts" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "total_results": 2,
  "limit": 50,
  "page": 1,
  "total_pages": 1,
  "result_from": 1,
  "result_to": 3,
  "data": [
    {
      "id": "6e5f36d27502ec69fda745ec59ead509",
      "object": "account",
      "username": "MisterDebugger",
      "created_at": "2025-02-11T08:28:14Z",
      "last_synchronization_time": "2025-02-11T08:28:14Z",
      "status": "200",
      "status_code_info": "synchronized",
      "status_code_description": "Success!",
      "type": "facebook-sync",
      "params": {
        "default": {},
        "user": {}
      },
      "updated_at": null,
      "account_type_hash": "16f5b7f91e8fc533eab88be973273a02",
      "squids": [],
      "baseurl": "https://www.facebook.com",
      "cookies": [
        {"name": "c_user", "required": true},
        {"name": "xs", "required": true}
      ],
      "icon": "<base64 image data>"
    },
    {
      "id": "abfeb440ceccdfab974e8d261836c9d6",
      "object": "account",
      "username": "MisterDebugger",
      "created_at": "2025-02-11T08:28:22Z",
      "last_synchronization_time": "2025-02-11T08:28:22Z",
      "status": "200",
      "status_code_info": "synchronized",
      "status_code_description": "Success!",
      "type": "twitter-sync",
      "params": {
        "default": {},
        "user": {}
      },
      "updated_at": null,
      "account_type_hash": "9853173fc00a940a33d7a420c176ad3b",
      "squids": [],
      "baseurl": "https://x.com",
      "cookies": [
        {"name": "auth_token", "required": true},
        {"name": "ct0", "required": true}
      ],
      "icon": "<base64 image data>"
    }
  ],
  "next": null,
  "previous": null
}
401
{
  "detail": "Invalid token."
}