> ## Documentation Index > Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt > Use this file to discover all available pages before exploring further. # List incentive redemptions > Returns a list of incentive redemptions across all clinics in the organization. The redemptions are sorted by creation date, with the most recent appearing first. An **incentive** is a clinic-funded discount on home delivery products, such as a percent or dollar amount off a first autoship order, recurring autoship orders, or any order. Incentives can apply automatically or require the client to enter a promo code. An **incentive redemption** records one use of an incentive on a single order item, and tracks how much the clinic spent on the discount along with the incentive's terms, the order, client, patient, and product it was applied to. A redemption counts toward clinic spend only while its order item is active, so redemptions on canceled order items are not part of this list. ## OpenAPI ````yaml get /ext/v2/incentive-redemptions/ openapi: 3.1.0 info: description: '' title: NinjaAPI version: 2.0.0 servers: - url: https://connect.vetcove.com/ security: [] paths: /ext/v2/incentive-redemptions/: get: tags: - Incentives summary: List incentive redemptions description: >- Returns a list of incentive redemptions across all clinics in the organization. The redemptions are sorted by creation date, with the most recent appearing first. An **incentive** is a clinic-funded discount on home delivery products, such as a percent or dollar amount off a first autoship order, recurring autoship orders, or any order. Incentives can apply automatically or require the client to enter a promo code. An **incentive redemption** records one use of an incentive on a single order item, and tracks how much the clinic spent on the discount along with the incentive's terms, the order, client, patient, and product it was applied to. A redemption counts toward clinic spend only while its order item is active, so redemptions on canceled order items are not part of this list. operationId: incentive_redemptions_list parameters: - description: When provided, filters to objects with these IDs. in: query name: ids required: false schema: anyOf: - items: type: integer type: array - type: 'null' description: When provided, filters to objects with these IDs. title: Ids - description: >- A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`. in: query name: ending_before required: false schema: anyOf: - type: integer - type: 'null' description: >- A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as `starting_after`. title: Ending Before - description: >- A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`. in: query name: starting_after required: false schema: anyOf: - type: integer - type: 'null' description: >- A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as `ending_before`. title: Starting After - description: The maximum number of items to return per page. in: query name: limit required: false schema: default: 10 description: The maximum number of items to return per page. maximum: 100 minimum: 1 title: Limit type: integer - description: Filter by the ID of the redeemed incentive. in: query name: incentive_id required: false schema: anyOf: - type: integer - type: 'null' description: Filter by the ID of the redeemed incentive. title: Incentive Id - description: Filter by the ID of the clinic. in: query name: clinic_id required: false schema: anyOf: - type: integer - type: 'null' description: Filter by the ID of the clinic. title: Clinic Id - description: Redemptions on orders placed on or after this date (YYYY-MM-DD). in: query name: order_placed_date__gte required: false schema: anyOf: - format: date type: string - type: 'null' description: Redemptions on orders placed on or after this date (YYYY-MM-DD). title: Order Placed Date Gte - description: Redemptions on orders placed on or before this date (YYYY-MM-DD). in: query name: order_placed_date__lte required: false schema: anyOf: - format: date type: string - type: 'null' description: Redemptions on orders placed on or before this date (YYYY-MM-DD). title: Order Placed Date Lte responses: '200': content: application/json: schema: $ref: '#/components/schemas/Incentive_RedemptionList' description: OK security: - ExternalAPIAuth: [] components: schemas: Incentive_RedemptionList: properties: data: description: A single page of data contained within this list. items: $ref: '#/components/schemas/ExternalIncentiveRedemptionSchema' title: Data type: array has_more: default: false description: Whether there are more pages or data in this list. title: Has More type: boolean next_page: description: A URL linking to the next page of this list. title: Next Page type: string type: default: list description: Type of this object. Always `list`. title: Type type: string required: - data - next_page title: Incentive RedemptionList type: object ExternalIncentiveRedemptionSchema: properties: clinic_client_id: description: ID of the clinic client that placed the order. title: Clinic Client Id type: integer clinic_id: description: ID of the clinic that received the order. title: Clinic Id type: integer clinic_patient_id: anyOf: - type: integer - type: 'null' description: ID of the clinic patient the order item is for. title: Clinic Patient Id created: description: The datetime this object was created. format: date-time title: Created type: string first_subscription_cents_value: anyOf: - type: integer - type: 'null' description: Amount off the first autoship order only, in cents. title: First Subscription Cents Value first_subscription_percent_value: anyOf: - type: number - type: 'null' description: >- Percent off the first autoship order only, as a fraction between 0 and 1. title: First Subscription Percent Value id: description: Unique identifier for the incentive redemption. title: Id type: integer incentive_id: description: ID of the incentive that was redeemed. title: Incentive Id type: integer incentive_name: description: Clinic-facing name of the incentive. title: Incentive Name type: string incentive_type: $ref: '#/components/schemas/ClinicIncentiveKind' description: The type of incentive as shown to clinic users. item_id: description: ID of the catalog item that was ordered. title: Item Id type: integer max_discount: anyOf: - type: integer - type: 'null' description: The maximum discount the incentive can provide, in cents. title: Max Discount min_order_subtotal: anyOf: - type: integer - type: 'null' description: >- The minimum order subtotal required to apply the incentive, in cents. title: Min Order Subtotal modified: description: >- The datetime this object was last modified; changes to related entities will not update this field. format: date-time title: Modified type: string non_subscription_cents_value: anyOf: - type: integer - type: 'null' description: Amount off any order, in cents. title: Non Subscription Cents Value non_subscription_percent_value: anyOf: - type: number - type: 'null' description: Percent off any order, as a fraction between 0 and 1. title: Non Subscription Percent Value order_display_number: description: User-facing display number of the order. title: Order Display Number type: string order_id: description: ID of the order the incentive was redeemed on. title: Order Id type: integer order_item_id: description: ID of the order item the incentive was redeemed on. title: Order Item Id type: integer promo_code: anyOf: - type: string - type: 'null' description: The promo code the client entered to redeem the incentive, if any. title: Promo Code recurring_subscription_cents_value: anyOf: - type: integer - type: 'null' description: Amount off recurring autoship orders, in cents. title: Recurring Subscription Cents Value recurring_subscription_percent_value: anyOf: - type: number - type: 'null' description: >- Percent off recurring autoship orders, as a fraction between 0 and 1. title: Recurring Subscription Percent Value spend: description: >- The amount the clinic spent on this redemption (the discount given to the client), in cents. title: Spend type: integer required: - created - modified - id - incentive_id - incentive_name - incentive_type - clinic_id - clinic_client_id - item_id - order_id - order_display_number - order_item_id - spend title: Incentive Redemption type: object ClinicIncentiveKind: enum: - STANDARD - AUTOSHIP - COMBO - GLOBAL_AUTOSHIP title: ClinicIncentiveKind type: string securitySchemes: ExternalAPIAuth: scheme: bearer type: http ````