Skip to main content
GET
/
accounts
Read all accounts
curl --request GET \
  --url https://api.stg.lumx.cloud/accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "d06d342c-629a-4d99-a26f-34e8ea528403",
      "customerId": "768d6aac-627e-44e8-aabd-d51d10f59c02",
      "status": "ACTIVE",
      "currency": "EUR",
      "createdAt": "2026-05-13T20:49:13.236Z",
      "updatedAt": "2026-05-14T13:55:15.418Z"
    },
    {
      "id": "af04e979-360a-428a-84e6-cbd8ffc4942b",
      "customerId": "768d6aac-627e-44e8-aabd-d51d10f59c02",
      "status": "ACTIVE",
      "currency": "USD",
      "createdAt": "2026-05-13T20:49:13.236Z",
      "updatedAt": "2026-05-14T13:55:15.567Z"
    },
    {
      "id": "8412f484-32fe-418f-80d1-99eb1b3ba7f3",
      "customerId": "768d6aac-627e-44e8-aabd-d51d10f59c02",
      "status": "ACTIVE",
      "currency": "BRL",
      "createdAt": "2026-05-13T20:49:13.236Z",
      "updatedAt": "2026-05-14T13:55:15.418Z"
    }
  ],
  "pagination": {
    "size": 25,
    "total": 3,
    "hasNextPage": false,
    "hasPreviousPage": false,
    "nextCursor": null,
    "previousCursor": null
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Query Parameters

​
size
integer
default:25

Number of accounts to return per page.

Required range: 1 <= x <= 100
​
cursor
string<uuid>

Cursor for pagination. Use the nextCursor or previousCursor from the previous response to get the next or previous page.

​
customerId
string<uuid>

Filter accounts by customer's unique identifier.

Response

200 - application/json

Accounts successfully retrieved.

​
data
object[]

An array containing all accounts.

​
pagination
object

Pagination metadata for the response.