---
title: "List account assignments"
method: GET
path: "/v1/account-assignments"
tags: ["Accounts"]
---

# List account assignments

`GET /v1/account-assignments`

## Request

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

List pending account assignments for the selected application within the current organization, including filters and pagination support.

## Query parameters

- `filters` union[]
  - union
    - object
      - `operator` 'or' | 'and', required
      - `value` union[], required
        - union
          - object
            - `field` 'id', required
            - `operator` 'eq', required
            - `value` string, required
          - object
            - `field` 'createdAt', required
            - `operator` 'gt' | 'lt' | 'gte' | 'lte', required
            - `value` string, date-time, required
          - object
            - `field` 'updatedAt', required
            - `operator` 'gt' | 'lt' | 'gte' | 'lte', required
            - `value` string, date-time, required
          - object
            - `field` 'application.id', required
            - `operator` 'eq', required
            - `value` string, uuid, required
    - object
      - `field` 'id', required
      - `operator` 'eq', required
      - `value` string, required
    - object
      - `field` 'createdAt', required
      - `operator` 'gt' | 'lt' | 'gte' | 'lte', required
      - `value` string, date-time, required
    - object
      - `field` 'updatedAt', required
      - `operator` 'gt' | 'lt' | 'gte' | 'lte', required
      - `value` string, date-time, required
    - object
      - `field` 'application.id', required
      - `operator` 'eq', required
      - `value` string, uuid, required
- `sorters` object[]
  - `field` 'id' | 'createdAt' | 'updatedAt', required
  - `order` 'asc' | 'desc', required
- `currentPage` integer
- `pageSize` integer
- `network` 'EthereumAnvil' | 'BaseSepolia' | 'BaseMainnet' | 'XdcApothem' | 'XdcMainnet' | 'StellarQuickstart' | 'StellarTestnet' | 'StellarMainnet'

## Response `200`

List of application account assignments retrieved successfully

- PaginatedAccountAssignmentDto
  - `data` object[], required: Array of items for the current page
    - `id` string, uuid, required: The unique identifier of the account assignment
    - `createdAt` string, date-time, required: Creation date (ISO 8601)
    - `updatedAt` string, date-time, required: Last update date (ISO 8601)
    - `application` string, uuid, required: The unique identifier of the application
    - `email` string, email, nullable: Contact email of the assigned account
    - `phoneNumber` string, e164, nullable: Contact phone number of the assigned account
    - `name` string, nullable: Name of the user to be assigned
    - `balance` union: The optimistic loyalty balance
      - string
      - number
    - `rewardTier` object, nullable, required
      - `id` string, uuid, required: Entity UUID
      - `createdAt` string, date-time, required: Creation date (ISO 8601)
      - `updatedAt` string, date-time, required: Last update date (ISO 8601)
      - `application` string, uuid, required: The unique identifier of the application
      - `name` string, required: The name of the loyalty reward tier
      - `requiredVisits` integer, required: The number of visits required to reach this reward tier
      - `currencyToPointRatio` integer, required: Number of loyalty points earned for each 1 unit of currency spent (e.g., if the ratio is 2 and currency is EUR, spending €1 earns 2 points). Used to calculate point accruals from transaction amounts.
      - `bgImageUrl` string, uri, nullable: Background image for the reward tier. Supported formats: WEBP (preferred), PNG. Recommended size: 1920×1080 px (landscape). Max file size: 1 MB.
  - `total` integer, required: Total count of items matching the query

---

[API](https://skmtc.dev/keyban/apis/keyban-rest-apis.md) · [All operations](https://skmtc.dev/keyban/apis/keyban-rest-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/keyban/apis/keyban-rest-apis/revisions/0bb79a1da961?raw)