> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rc.cleverhub.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get User List

> Retrieves a paginated list of users associated with the site. This endpoint allows merchants to view all users who have activated their cashback accounts, including their personal information and account creation dates. Supports pagination to manage large datasets.




## OpenAPI

````yaml /api/openapi/cashback-reference.yaml get /v2/cashbacks/users
openapi: 3.0.3
info:
  title: Cashback APIs
  description: >-
    ## Introduction

    The Cashback API Solution offers a streamlined way for developers to manage
    cashback campaigns, account activations, and withdrawals, providing a
    seamless user experience.

    ### Key Features

    - **Campaign Management**:
      - **Get Cashback Campaign List**: Retrieve a list of all available cashback campaigns.
      - **Get Campaign Configurations**: Retrieve detailed configurations for specific cashback campaigns.

    - **User Cashback Management**:
      - **Activate User's Cashback Account**: Activate a cashback account for a user.
      - **Initiate Cashback Delivery**: Initiate the delivery of cashback to a user.
      - **Initiate Cashback Withdrawal**: Begin the process of withdrawing cashback to a user's account.

    - **User Information**:
      - **Get User List**: Retrieve a list of users with cashback accounts.

    This documentation provides detailed guidance for integrating these
    capabilities into your application.
  version: 2.0.0
  termsOfService: https://helloclever.co/terms
  contact:
    email: support@helloclever.co
servers:
  - url: https://api.cleverhub.co/api
    description: Sandbox Environment
  - url: https://api-merchant.helloclever.co/api
    description: Production Environment
security: []
paths:
  /v2/cashbacks/users:
    get:
      tags:
        - Cashback
      summary: Get User List
      description: >
        Retrieves a paginated list of users associated with the site. This
        endpoint allows merchants to view all users who have activated their
        cashback accounts, including their personal information and account
        creation dates. Supports pagination to manage large datasets.
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: >-
            The page number to retrieve in the paginated response. Defaults to 1
            if not specified.
          example: 1
        - in: query
          name: per_page
          schema:
            type: integer
            default: 10
          description: >-
            The number of records to display per page. Defaults to 10 if not
            specified.
          example: 10
      responses:
        '200':
          description: A successful response containing a list of users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  page:
                    type: integer
                    description: The current page number in the paginated response.
                    example: 1
                  per_page:
                    type: integer
                    description: The number of records displayed per page.
                    example: 2
                  next_page:
                    type: integer
                    nullable: true
                    description: >-
                      The page number of the next page, or null if there is no
                      subsequent page.
                    example: null
                  total_page:
                    type: integer
                    description: >-
                      The total number of pages available based on the current
                      query.
                    example: 1
                  total_count:
                    type: integer
                    description: The total number of users available across all pages.
                    example: 1
                  records:
                    type: array
                    description: An array of user objects for the current page.
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          description: The unique identifier of the user.
                          example: 8GAVZZKTI3
                        site_id:
                          type: string
                          description: >-
                            The unique identifier of the site associated with
                            the user.
                          example: 3BAVFJ6H
                        first_name:
                          type: string
                          description: The user's first name.
                          example: example
                        last_name:
                          type: string
                          description: The user's last name.
                          example: example
                        email:
                          type: string
                          description: The user's email address.
                          example: example@gmail.com
                        phone:
                          type: string
                          description: The user's phone number.
                          example: '+61412345678'
                        created_at:
                          type: string
                          format: date-time
                          description: The timestamp when the user was created.
                          example: '2024-11-06T16:39:48.264Z'
                        updated_at:
                          type: string
                          format: date-time
                          description: >-
                            The timestamp when the user's information was last
                            updated.
                          example: '2024-11-06T16:39:48.264Z'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
        - app-id: []
          secret-key: []
components:
  securitySchemes:
    app-id:
      type: apiKey
      in: header
      name: app-id
      description: |
        A unique identifier assigned to each application.
    secret-key:
      type: apiKey
      in: header
      name: secret-key
      description: |
        A secure token associated with the `app-id`.

````

## Related topics

- [Drive Loyalty with Cashback Campaigns](/developer-reference/api-use-cases/drive-loyalty-with-cashback-campaigns.md)
- [Get Cashback Campaign List](/api/cashback/get-cashback-campaign-list.md)
- [Get Payment Request List](/api/aud-bsbaccount-number/get-payment-request-list.md)