> ## 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.

# List wallet promotions

> Promotions in the diner's wallet that work on this channel's brand. To use one, apply its `code` to the cart with [Apply promo](/connect/storefront-api/cart/apply-promo).




## OpenAPI

````yaml specs/accounts-v1.yaml GET /promotions
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:
  /promotions:
    get:
      tags:
        - Loyalty
      summary: List wallet promotions
      description: >
        Promotions in the diner's wallet that work on this channel's brand. To
        use one, apply its `code` to the cart with [Apply
        promo](/connect/storefront-api/cart/apply-promo).
      operationId: listWalletPromotions
      responses:
        '200':
          description: The diner's wallet promotions
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    example: user_promotion
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/WalletPromotion'
              example:
                object: user_promotion
                items:
                  - id: 1
                    code: WELCOME15
                    label: 15% Off Welcome Discount
                    description: Get 15% off your order
                    value: 15
                    value_type: percent
                    value_cap: 1000
                    active: true
                    start_date: '2026-11-16'
                    end_date: '2027-05-16'
                    max_claims_per_user: 1
                    claims_reset_period: none
                    remaining_claims_count: 1
                    unreleased_claims_count: 0
                    fully_redeemed: false
                  - id: 2
                    code: SAVE5
                    label: $5 Off Your Order
                    description: Save $5 on your order
                    value: 500
                    value_type: fractional
                    value_cap: null
                    active: true
                    start_date: '2026-11-16'
                    end_date: '2027-02-16'
                    max_claims_per_user: 5
                    claims_reset_period: none
                    remaining_claims_count: 5
                    unreleased_claims_count: 0
                    fully_redeemed: false
        '401':
          $ref: '#/components/responses/NotSignedIn'
        '403':
          $ref: '#/components/responses/NotVerified'
components:
  schemas:
    WalletPromotion:
      type: object
      properties:
        id:
          type: integer
        code:
          type: string
          description: Apply this to the cart with Apply promo
        label:
          type: string
        description:
          type:
            - string
            - 'null'
        value:
          type: integer
          description: >-
            Percent when `value_type` is `percent`; cents when it is
            `fractional`
        value_type:
          type: string
          enum:
            - percent
            - fractional
        value_cap:
          type:
            - integer
            - 'null'
          description: Most a percent discount can take off, in cents
        active:
          type: boolean
        start_date:
          type:
            - string
            - 'null'
          format: date
        end_date:
          type:
            - string
            - 'null'
          format: date
        max_claims_per_user:
          type:
            - integer
            - 'null'
        claims_reset_period:
          type: string
          description: How often the diner's claims reset, or `none`
        remaining_claims_count:
          type: integer
          description: Times this diner can still use it
        unreleased_claims_count:
          type: integer
          description: Claims reserved by carts that haven't been paid yet
        fully_redeemed:
          type: boolean
    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.