Skip to content

List accounts

Request

Retrieve a paginated list of accounts the partner integrator is authorized to access.

Security
PartnerApiKey and PartnerOAuth
Query
sortBystring(?i)ID

Sort by field

Default:"ID"
Value:"ID"
sortDirstring(?i)(?:ASC|DESC)

Sort direction

Default:"ASC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account?sortBy=ID&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Accounts retrieved successfully

Bodyapplication/json
accountsArray of objects(AccountResponse)

List of authorized accounts in this page

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Response
{
  "accounts": [
    { … }
  ],
  "nextCursor": "string"
}