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

# Get point history

> The diner's points earned and used in the channel's point program, newest first. If the channel has no point program, the list is empty.




## OpenAPI

````yaml specs/accounts-v1.yaml GET /point_history
openapi: 3.1.0
info:
  title: Atlas Accounts API
  version: 1.0.0
  description: ''
servers:
  - url: https://api.atlas.kitchen/accounts/v1
    description: Accounts API
security:
  - channelId: []
    sessionId: []
tags:
  - name: Introduction
    description: >
      The Accounts API lets a diner sign in on your storefront, then read and
      manage their own account with the merchant: profile, saved addresses, past
      orders, points and wallet promotions.


      It uses the same `X-Channel-Id` and `X-Session-Id` headers as the
      [Storefront API](/connect/storefront-api/authentication). Signing in
      attaches the diner to the session, so the Storefront API cart can use and
      earn their points.


      Everything here belongs to one merchant. The channel decides the merchant,
      and the merchant's point program for the channel's brand decides the
      points. The same diner can have different balances with different
      merchants.
  - name: Sign in
    description: Request a one-time code and sign the diner in.
  - name: Profile
    description: The signed-in diner's details.
  - name: Addresses
    description: Delivery addresses the signed-in diner has saved.
  - name: Orders
    description: The signed-in diner's past orders with this merchant.
  - name: Loyalty
    description: The signed-in diner's points and wallet promotions.
paths:
  /point_history:
    get:
      tags:
        - Loyalty
      summary: Get point history
      description: >
        The diner's points earned and used in the channel's point program,
        newest first. If the channel has no point program, the list is empty.
      operationId: getPointHistory
      parameters:
        - name: state
          in: query
          schema:
            type: string
            enum:
              - awarded
              - deducted
              - expiring
              - expired
          description: >
            - `awarded`: points earned that have an expiry date still to come

            - `deducted`: points used

            - `expiring`: points earned that expire in the next 30 days

            - `expired`: points earned whose expiry date has passed, including
            any fully used before then
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        '200':
          description: One page of point transactions
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    example: point_transaction
                  current_page:
                    type: integer
                  per_page:
                    type: integer
                  total_count:
                    type: integer
                  total_pages:
                    type: integer
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PointTransaction'
              example:
                object: point_transaction
                current_page: 1
                per_page: 20
                total_count: 2
                total_pages: 1
                items:
                  - id: 9
                    type: award
                    event_name: Order A-1024
                    comment: null
                    amount: 40
                    amount_value: null
                    points_remaining: 40
                    expires_at: '2026-11-28'
                    order_id: 1024
                    created_at: 1794935538
                  - id: 8
                    type: award
                    event_name: Welcome bonus
                    comment: null
                    amount: 500
                    amount_value: null
                    points_remaining: 500
                    expires_at: '2027-02-18'
                    order_id: null
                    created_at: 1794935538
        '401':
          $ref: '#/components/responses/NotSignedIn'
        '403':
          $ref: '#/components/responses/NotVerified'
        '422':
          description: '`state` is not one of the allowed values'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                type: Invalid Parameter
                message: >-
                  Validation failed for one or more fields. Please check your
                  request and try again.
                details:
                  - field: state
                    message: 'must be one of: awarded, deducted, expiring, expired'
components:
  schemas:
    PointTransaction:
      type: object
      properties:
        id:
          type: integer
        type:
          type: string
          enum:
            - award
            - usage
          description: '`award` for points earned, `usage` for points spent'
        event_name:
          type: string
          description: What the points were for, as shown to the diner
        comment:
          type:
            - string
            - 'null'
        amount:
          type: integer
          description: Points earned or used
        amount_value:
          type:
            - integer
            - 'null'
          description: For `usage`, what the points were worth in cents
        points_remaining:
          type:
            - integer
            - 'null'
          description: >-
            For `award`, points from this award not used yet. `null` for
            `usage`.
        expires_at:
          type:
            - string
            - 'null'
          format: date
          description: For `award`, the date these points expire
        order_id:
          type:
            - integer
            - 'null'
        created_at:
          type: integer
          description: Unix timestamp
    Error:
      type: object
      properties:
        type:
          type: string
          example: Invalid Parameter
        message:
          type: string
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    NotSignedIn:
      description: No diner is signed in on this session, or the session ID is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            type: Unauthorized
            message: >-
              You did not provide valid credentials for this request. Please
              check your request and try again.
            details:
              - field: login
                message: You have to be logged in to process this request.
    NotVerified:
      description: >-
        The diner hasn't verified their mobile number yet. Sign them in with a
        code to verify it.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            type: Forbidden
            message: >-
              You do not have permission to process this request. Please check
              your credentials or contact support if the issue persists.
            details:
              - field: mobile_number
                message: >-
                  Your mobile number is not verified. Verify your mobile number
                  first before managing your account.
  securitySchemes:
    channelId:
      type: apiKey
      in: header
      name: X-Channel-Id
      description: Merchant storefront identifier. Provided during onboarding.
    sessionId:
      type: apiKey
      in: header
      name: X-Session-Id
      description: >-
        Diner session identifier from the Storefront API's `GET /channel`. Log
        in returns a new one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.