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

# List rewards

> Retrieves the details and status of rewards you've previously ordered through
`/campaign`, `/direct_links`, or `/embedded`. All date/time fields are in
Pacific Standard Time.




## OpenAPI

````yaml /api-reference/openapi.yaml get /gifts
openapi: 3.1.0
info:
  title: Giftbit API
  version: v1
  description: >
    Giftbit's REST API lets you automatically order rewards and send them to
    your

    recipients. Delivery can be handled either by links that integrate into
    another

    system's workflow, or by emails sent through the Giftbit system.


    Authenticate every request with a bearer token in the `Authorization`
    header.

    Only an HTTP `200` means success; all non-`200` responses share a common
    error body.
  contact:
    name: Giftbit Support
    email: testbed@giftbit.com
    url: https://www.giftbit.com/api-documentation
servers:
  - url: https://api-testbed.giftbit.com/papi/v1
    description: Testbed
  - url: https://api.giftbit.com/papi/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Ping
    description: Test your authentication and check the health of the Giftbit API.
  - name: Brands
    description: List reward brands and retrieve extended information about a single brand.
  - name: Regions
    description: List the regions used to filter brands and request Full Catalog rewards.
  - name: Email Orders
    description: Order one or more rewards delivered to recipients by Giftbit email.
  - name: Shortlink Orders
    description: Order branded shortlink rewards that include a customized landing page.
  - name: Direct Link Orders
    description: >-
      Order minimally branded direct link rewards returned immediately in the
      response.
  - name: Embedded Rewards
    description: >-
      Order a single in-app reward for immediate delivery in your app or
      website.
  - name: Funds
    description: Retrieve your account balance and top it up with a credit card payment.
  - name: Rewards
    description: List, retrieve, resend, and cancel individual rewards.
paths:
  /gifts:
    get:
      tags:
        - Rewards
      summary: List rewards
      description: >
        Retrieves the details and status of rewards you've previously ordered
        through

        `/campaign`, `/direct_links`, or `/embedded`. All date/time fields are
        in

        Pacific Standard Time.
      operationId: list-rewards
      parameters:
        - name: uuid
          in: query
          required: false
          description: Return the reward with matching uuid.
          schema:
            type: string
        - name: campaign_uuid
          in: query
          required: false
          description: Filter rewards by the order with the matching uuid.
          schema:
            type: string
        - name: campaign_id
          in: query
          required: false
          description: Filter rewards by the order with the matching order id.
          schema:
            type: string
        - name: price_in_cents_greater_than
          in: query
          required: false
          schema:
            type: integer
        - name: price_in_cents_less_than
          in: query
          required: false
          schema:
            type: integer
        - name: recipient_name
          in: query
          required: false
          description: Filter by recipient name (at least 3 characters).
          schema:
            type: string
        - name: recipient_email
          in: query
          required: false
          description: Filter by recipient email (at least 3 characters).
          schema:
            type: string
        - name: delivery_status
          in: query
          required: false
          schema:
            type: string
            enum:
              - UNSENT
              - DELIVERED
              - UNDELIVERABLE
              - TEMPORARILY_UNDELIVERABLE
              - UNSUBSCRIBED
              - COMPLAINT
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - SENT_AND_REDEEMABLE
              - REDEEMED
              - TO_CHARITY
              - GIVER_CANCELLED
              - EXPIRED
        - name: created_date_greater_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: created_date_less_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: delivery_date_greater_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: delivery_date_less_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: redelivery_count_greater_than
          in: query
          required: false
          schema:
            type: integer
        - name: redelivery_count_less_than
          in: query
          required: false
          schema:
            type: integer
        - name: redeemed_date_greater_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: redeemed_date_less_than
          in: query
          required: false
          description: Format `yyyy-MM-dd HH:mm:ss`.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Maximum number of rewards to return. Default 20.
          schema:
            type: integer
            default: 20
        - name: offset
          in: query
          required: false
          description: Offset of the first reward in the total results. Default 0.
          schema:
            type: integer
            default: 0
        - name: sort
          in: query
          required: false
          schema:
            type: string
            enum:
              - campaign_id
              - price_in_cents
              - recipient_name
              - recipient_email
              - delivery_status
              - status
        - name: order
          in: query
          required: false
          description: Sort order. Default desc.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: Rewards matching your search parameters.
          content:
            application/json:
              schema:
                type: object
                properties:
                  gifts:
                    type: array
                    items:
                      $ref: '#/components/schemas/Gift'
                  number_of_results:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
                  total_count:
                    type: integer
                  info:
                    $ref: '#/components/schemas/Info'
                  status:
                    type: integer
              example:
                gifts:
                  - uuid: d30be501ed2546e580c5c9eaf56633d9
                    campaign_uuid: 8f5835dfb637413793c5d55f8ea95e23
                    delivery_status: DELIVERED
                    status: SENT_AND_REDEEMABLE
                    management_dashboard_link: >-
                      http://testbedapp.giftbit.com/campaign/campaignInfo?uuid=8f5835dfb637413793c5d55f8ea95e23&gift_uuid=d30be501ed2546e580c5c9eaf56633d9
                    redelivery_count: 0
                    campaign_id: may11
                    price_in_cents: 500
                    brand_code: itunesus
                    marketplacegift_id: '1'
                    created_date: '2016-05-11 12:18:25'
                    delivery_date: '2016-05-11 12:18:32'
                number_of_results: 1
                limit: 1
                offset: 0
                total_count: 8355
                info:
                  code: INFO_GIFTS
                  name: Gift information retrieved
                  message: Returned gifts matching your search parameters.
                status: 200
components:
  schemas:
    Gift:
      type: object
      description: A single reward.
      properties:
        uuid:
          type: string
        campaign_uuid:
          type: string
        delivery_status:
          type: string
          enum:
            - UNSENT
            - DELIVERED
            - LINKCREATED
            - UNDELIVERABLE
            - TEMPORARILY_UNDELIVERABLE
            - UNSUBSCRIBED
            - COMPLAINT
        status:
          type: string
          enum:
            - SENT_AND_REDEEMABLE
            - REDEEMED
            - TO_CHARITY
            - GIVER_CANCELLED
            - EXPIRED
        management_dashboard_link:
          type: string
        redelivery_count:
          type: integer
        campaign_id:
          type: string
        price_in_cents:
          type: integer
        brand_code:
          type: string
        marketplacegift_id:
          type: string
          description: Deprecated. Refer to brand_code.
        recipient_name:
          type: string
        recipient_email:
          type: string
        created_date:
          type: string
        delivery_date:
          type: string
    Info:
      type: object
      description: Status information returned on successful requests.
      properties:
        code:
          type: string
          description: An enum-style status code for the request.
        name:
          type: string
          description: Human-readable status name.
        message:
          type: string
          description: Request-context-specific message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Send your API token prefixed by `Bearer ` in the `Authorization` header.

````