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

# List Loyalty Programs

> List loyalty programs



## OpenAPI

````yaml https://app.levanta.io/api/creator/v1/openapi.json get /loyalty-programs
openapi: 3.1.0
info:
  version: 1.0.0
  title: Levanta Creator API
  description: >-
    Authorize all requests with an API key in the Authorization header as the
    second token. E.g. Authorization -> "Bearer {api_key}".
servers:
  - url: https://app.levanta.io/api/creator/v1
security: []
externalDocs:
  url: https://app.levanta.io/creator/api-docs
paths:
  /loyalty-programs:
    get:
      tags:
        - Loyalty Programs
      summary: List Loyalty Programs
      description: List loyalty programs
      operationId: ListLoyaltyPrograms
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 25
            description: The maximum number of items to return
          required: false
          description: The maximum number of items to return
          name: limit
          in: query
        - schema:
            type: string
            maxLength: 512
            description: >-
              The cursor returned from the last request, if omitted the first
              page will be returned
          required: false
          description: >-
            The cursor returned from the last request, if omitted the first page
            will be returned
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - active
              - ended
              - all
            default: active
          required: false
          name: status
          in: query
        - schema:
            type: string
            description: Comma-delimited list of UUIDs representing an array
          required: false
          description: Comma-delimited list of UUIDs representing an array
          name: brand_ids
          in: query
        - schema:
            type: string
            description: Comma-delimited list of UUIDs representing an array
          required: false
          description: Comma-delimited list of UUIDs representing an array
          name: program_ids
          in: query
        - schema:
            type: string
            enum:
              - amazon.com
            default: amazon.com
          required: false
          name: marketplace
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  programs:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        brand:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                          required:
                            - id
                            - name
                        membershipActiveThrough:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The date your membership for the loyalty program is
                            active until.
                                                 Will equal endMonth if the program has not been cancelled and you have not been removed.
                                                 If null, the program doesn't have a set end date and your membership is active indefinitely.
                                                 Format: yyyy-MM
                                                
                        startMonth:
                          type: string
                          description: >-
                            The program is active from the start of this month.
                            Format: yyyy-MM
                        endMonth:
                          type:
                            - string
                            - 'null'
                          description: >-
                            The program is active until the end of this month.
                            Format: yyyy-MM.
                                                 If null the program is active indefinitely
                        target:
                          type: object
                          properties:
                            sales:
                              type: number
                              description: >-
                                The sales target for the loyalty program. For
                                every sales target reached you will earn bonus
                                amount.
                                                        This is cyclical so if sales is $50 and bonus is $10 if you drive $120 you will earn $20 in bonus.
                                                        
                            bonus:
                              type: number
                              description: >-
                                The bonus amount to be awarded for every sales
                                target reached.
                          required:
                            - sales
                            - bonus
                        accrued:
                          type: object
                          properties:
                            sales:
                              type: number
                              description: >-
                                The total sales that count for this loyalty
                                program
                            bonus:
                              type: number
                              description: >-
                                The total bonus you have accrued for this
                                loyalty program
                          required:
                            - sales
                            - bonus
                        currency:
                          type: string
                          enum:
                            - USD
                            - GBP
                            - CAD
                            - EUR
                            - MXN
                      required:
                        - id
                        - name
                        - brand
                        - membershipActiveThrough
                        - startMonth
                        - endMonth
                        - target
                        - accrued
                        - currency
                  cursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The cursor to use for the next request, if empty there are
                      no more items to return
                required:
                  - programs
                  - cursor
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    enum:
                      - 401
                  message:
                    type: string
                    enum:
                      - Unauthorized
                required:
                  - status
                  - message
        '422':
          description: Input Validation Failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    enum:
                      - 422
                  message:
                    type: string
                    enum:
                      - Input Validation Failed
                required:
                  - status
                  - message
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````