> ## Documentation Index
> Fetch the complete documentation index at: https://dev.smile.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List points transactions

> Retrieves a list of points transactions.

export const scope_0 = "points_transaction:read"

<Callout icon="key" iconType="regular">
  This endpoint requires the **{scope_0}** scope.
</Callout>

Results are sorted by `id` in descending order. This endpoint is commonly used to display a customer's points earning history.


## OpenAPI

````yaml schemas/rest-api.json GET /points_transactions
openapi: 3.1.0
info:
  title: Smile.io REST API
  version: 1.0.0
  description: A RESTful interface for interacting with Smile.io loyalty programs.
servers:
  - url: https://api.smile.io/v1
security:
  - bearerAuth: []
paths:
  /points_transactions:
    get:
      tags:
        - Points Transactions
      summary: List points transactions
      description: Retrieves a list of points transactions.
      operationId: get__points_transactions
      parameters:
        - name: customer_id
          in: query
          required: false
          schema:
            type: integer
            description: >-
              Filter results to only points transactions with the provided Smile
              customer ID.
          description: >-
            Filter results to only points transactions with the provided Smile
            customer ID.
        - name: updated_at_min
          in: query
          required: false
          schema:
            type: string
            description: >-
              Filter results to only points transactions updated at or after the
              provided date and time.
            format: date-time
          description: >-
            Filter results to only points transactions updated at or after the
            provided date and time.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            description: The maximum number of points transactions to retrieve.
            example: 1
            minimum: 1
            maximum: 250
            default: 50
          description: The maximum number of points transactions to retrieve.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            description: Cursor for the page of points transactions to retrieve.
          description: Cursor for the page of points transactions to retrieve.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  points_transactions:
                    type: array
                    items:
                      $ref: '#/components/schemas/PointsTransaction'
                  metadata:
                    $ref: '#/components/schemas/PaginationMetadata'
components:
  schemas:
    PointsTransaction:
      type: object
      properties:
        id:
          type: integer
          example: 825673452
          description: Unique identifier for the points transaction.
        customer_id:
          type: integer
          example: 304169228
          description: >-
            The ID of the customer whose balance this points transaction applies
            to.
        points_change:
          type: integer
          example: 100
          description: >-
            The number of points added or removed from the customer's points
            balance. The value is positive if points were added to the
            customer's balance and negative if points were deducted.
        description:
          type: string
          example: Points correction
          description: >-
            A message visible to the customer that describes the reason for the
            points change.
        internal_note:
          type:
            - string
            - 'null'
          example: 'Due to issue with order #6834'
          description: >-
            A note that is visible to the merchant. This note should never be
            visible to customers.
        created_at:
          type: string
          format: date-time
          example: '2024-12-07T20:15:27.893Z'
          description: The date and time when the points transaction was created.
        updated_at:
          type: string
          format: date-time
          example: '2024-12-07T20:15:27.893Z'
          description: The date and time when the points transaction was last updated.
    PaginationMetadata:
      type: object
      properties:
        next_cursor:
          type:
            - string
            - 'null'
          example: aWQ6MixkaXJlY3Rpb246bmV4dA==
          description: >-
            A cursor value that when present, can be used to retrieve the next
            page of results.
        previous_cursor:
          type:
            - string
            - 'null'
          example: ''
          description: >-
            A cursor value that when present, can be used to retrieve the
            previous page of results.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````