Skip to content
Account

List Accounts

Retrieve a paginated list of all connected platform accounts

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/accounts

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

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Response Structure

total_resultsinteger

Total number of accounts. Example: 2

limitinteger

Maximum results per page. Example: 50

pageinteger

Current page number. Example: 1

total_pagesinteger

Total number of pages. Example: 1

result_frominteger

Starting result index. Example: 1

result_tointeger

Ending result index. Example: 3

dataarray

Array of account objects. Example: [...]

nextstring | null

URL for next page (null if last page). Example: null

previousstring | null

URL for previous page (null if first page). Example: null

Account Object Fields

idstring

Unique account identifier. Example: "6e5f36d27502ec69fda745ec59ead509"

objectstring

Always "account". Example: "account"

usernamestring

Platform username. Example: "MisterDebugger"

created_atstring

Account creation timestamp (ISO 8601). Example: "2025-02-11T08:28:14Z"

last_synchronization_timestring

Last sync timestamp. Example: "2025-02-11T08:28:14Z"

statusstring

HTTP status code. Example: "200"

status_code_infostring

Status information. Example: "synchronized"

status_code_descriptionstring

Human-readable status message. Example: "Success!"

typestring

Account type identifier. Example: "facebook-sync"

paramsobject

Account parameters (default and user-specific). Example: {"default": {}, "user": {}}

Show params.user fields
user.is_proboolean

Leboncoin accounts only. true for a professional Leboncoin account, false for a personal one. Absent until the account sends a message or is synchronized again.

updated_atstring | null

Last update timestamp. Example: null

account_type_hashstring

Account type identifier hash. Example: "16f5b7f91e8fc533eab88be973273a02"

squidsarray

Array of squids using this account. Example: []

baseurlstring

Platform base URL. Example: "https://www.facebook.com"

cookiesarray

Required cookie names for authentication. Example: [{"name": "c_user", "required": true}]

iconstring

Base64 encoded platform icon. Example: "<base64 image data>"

primary_colorstring

The platform's brand colour, as a hex code — used to render the account in the dashboard. Example: "#FF9900"

lock_timeinteger | null

Unix timestamp at which a locked account unlocks again, or null when the account is not locked. Example: null

resets_ininteger | null

Seconds until runs paused by a full limit of this account resume (the next free slot), or null when no limit is reached. Example: null

limitsarray

The account's limits, each over a rolling 24 hours: an action (a profile, a search, a message) frees its slot 24 hours after it was counted, so there is no daily reset. One object per limit. The Leboncoin message sender's batch (messages sent in one go, then a pause) is not a 24-hour limit and stays in params.

Show limit fields
keystring

The limit, as named in params. Example: "profiles"

displaystring

Its label. Example: "Profiles per 24h"

maxinteger

The account's limit. Example: 100

used_24hinteger

Actions counted in the last 24 hours. Example: 53

remaininginteger

Actions still possible now. Example: 47

next_capacity_atstring | null

While the limit is full, when the next slot frees (UTC): runs paused by this limit resume then. null while there is room. Example: null

full_capacity_atstring | null

When everything counted now has left the 24 hours (UTC). null when nothing is counted. Example: "2026-11-12T13:35:00Z"

by_hourarray

The last 24 hours, one item per hour, oldest first. Example: [{"hour": "2026-11-11T13:00:00Z", "count": 53}, ...]

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."
}