Skip to main content
GET
/
v2
/
accounts
List Accounts
curl --request GET \
  --url https://api.example.com/v2/accounts \
  --header 'x-api-key: <x-api-key>'
{
  "success": true,
  "data": {
    "items": [
      {
        "account_id": "acc_abc123",
        "platform": "linkedin",
        "account_name": "John Doe",
        "is_active": true,
        "status": "active",
        "country": "FR",
        "created_at": "2025-10-15T08:30:00Z",
        "updated_at": "2026-03-20T14:22:00Z"
      },
      {
        "account_id": "acc_def456",
        "platform": "linkedin",
        "account_name": "Jane Smith",
        "is_active": false,
        "status": "inactive",
        "country": "US",
        "created_at": "2025-11-01T12:00:00Z",
        "updated_at": "2026-02-10T09:15:00Z"
      }
    ],
    "total": 1247,
    "limit": 50,
    "offset": 0
  },
  "metadata": {
    "action": "list_accounts",
    "credits_consumed": 0,
    "timestamp": "2026-04-28T12:00:00Z"
  }
}
Retrieve a paginated list of accounts linked to your API key. Use the returned account_id values in all subsequent V2 action requests.
This endpoint is free — it does not consume any credits.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Query Parameters

​
limit
integer
default:"50"
Maximum number of accounts to return per page (1-500).
​
offset
integer
default:"0"
Number of accounts to skip — use with limit to paginate (e.g. offset=50&limit=50 for page 2).

​
Response

​
success
boolean
Whether the request was successful
​
data
object
​
metadata
object
{
  "success": true,
  "data": {
    "items": [
      {
        "account_id": "acc_abc123",
        "platform": "linkedin",
        "account_name": "John Doe",
        "is_active": true,
        "status": "active",
        "country": "FR",
        "created_at": "2025-10-15T08:30:00Z",
        "updated_at": "2026-03-20T14:22:00Z"
      },
      {
        "account_id": "acc_def456",
        "platform": "linkedin",
        "account_name": "Jane Smith",
        "is_active": false,
        "status": "inactive",
        "country": "US",
        "created_at": "2025-11-01T12:00:00Z",
        "updated_at": "2026-02-10T09:15:00Z"
      }
    ],
    "total": 1247,
    "limit": 50,
    "offset": 0
  },
  "metadata": {
    "action": "list_accounts",
    "credits_consumed": 0,
    "timestamp": "2026-04-28T12:00:00Z"
  }
}

​
Notes

  • Use the account_id from the response in all V2 action requests
  • Only accounts with is_active: true can be used for actions
  • Results are sorted by created_at descending (newest first)
  • Default page size is 50; the maximum allowed limit is 500. To page through all accounts, increment offset by limit until offset + limit >= total