Accounts

List accounts

List all accounts for the current organization's selected application, returning blockchain addresses, loyalty balances, and pagination metadata.

get/v1/accounts

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/accounts
  • Auth: one of:
    • API key in header X-Api-Key
    • bearer (a scheme the document does not define)

Query parameters

field'id' | 'createdAt' | 'updatedAt' | 'address' | 'loyalty.optimisticBalance' | 'loyalty.visits' | 'dpp.passportCount' | 'dpp.lastActivityAt' required
order'asc' | 'desc' required
currentPageinteger

1-based page index.

pageSizeinteger

Number of items per page.

Response

List of application accounts retrieved successfully.

totalinteger required

Total count of items matching the query

Example response

{
  "data": [
    {
      "user": {
        "name": "Alice Dupont",
        "email": "alice@example.com",
        "image": "https://cdn.example.com/avatars/alice.png",
        "phoneNumber": "+33612345678",
        "birthDate": "1990-03-15",
        "preferredLocale": "fr-FR"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.