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

# Get gifting config

> Returns the calling shop's saved gifting rules. Returns a default-shaped config when none is persisted yet.

<Warning>
  This endpoint is in beta and subject to change.
</Warning>

<Note>
  **OAuth scope:** `giveaway_read`

  API keys have full access to this endpoint.
</Note>


## OpenAPI

````yaml GET /open-api/v1.0/gifting/config
openapi: 3.1.0
info:
  title: Fourthwall APIs
  description: Service used for management of orders, carts, and payments.
  termsOfService: https://fourthwall.com/terms-of-service
  contact:
    name: Backend team
    url: https://fourthwall.com
    email: backend@fourthwall.com
  version: unspecified
servers:
  - url: https://api.fourthwall.com
    description: Production server
security: []
externalDocs:
  description: OpenAPI documentation
  url: https://docs.fourthwall.com
paths:
  /open-api/v1.0/gifting/config:
    get:
      tags:
        - Gifting
      summary: Get gifting config
      description: >-
        Returns the calling shop's saved gifting rules. Returns a default-shaped
        config when none is persisted yet.
      operationId: get-gifting-config
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GiftingConfigXResponse'
      security:
        - oauth:
            - giveaway_read
        - basicAuth: []
      externalDocs:
        url: >-
          https://docs.fourthwall.com/api-reference/platform/gifting/get-gifting-config
components:
  schemas:
    GiftingConfigXResponse:
      type: object
      description: A shop's saved gifting rules.
      properties:
        enabled:
          type: boolean
          description: Master "gift while live" flag.
        entryTimeLimitSeconds:
          type: integer
          format: int32
          description: Entry time limit in seconds (20-180), maps to the giveaway duration.
        shipping:
          oneOf:
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllCreator
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllWinner
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.MaxCreator
        products:
          oneOf:
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.AllProducts
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.ExcludedProducts
            - $ref: >-
                #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.SelectedProducts
        platform:
          type: string
          description: >-
            Current giveaway platform owning the shop's single gifting slot.
            Read-only conflict signal — TWITCH or STREAMELEMENTS means another
            integration owns the slot. A Kick shop operates on the OPEN_API
            slot.
          enum:
            - TWITCH
            - STREAMELEMENTS
            - OPEN_API
            - NOT_SELECTED
      required:
        - enabled
        - entryTimeLimitSeconds
        - platform
        - products
        - shipping
      title: Gifting Config X Response
    com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllCreator:
      allOf:
        - $ref: '#/components/schemas/ShippingPolicyXResponse'
        - type: object
          properties:
            type:
              type: string
              const: ALL_CREATOR
      title: All Creator
    com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllWinner:
      allOf:
        - $ref: '#/components/schemas/ShippingPolicyXResponse'
        - type: object
          properties:
            type:
              type: string
              const: ALL_WINNER
      title: All Winner
    com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.MaxCreator:
      allOf:
        - $ref: '#/components/schemas/ShippingPolicyXResponse'
        - type: object
          properties:
            max:
              type: number
              format: double
        - type: object
          properties:
            type:
              type: string
              const: MAX_CREATOR
      required:
        - max
      title: Max Creator
    com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.AllProducts:
      allOf:
        - $ref: '#/components/schemas/ProductsPolicyXResponse'
        - type: object
          properties:
            type:
              type: string
              const: ALL
      title: All Products
    com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.ExcludedProducts:
      allOf:
        - $ref: '#/components/schemas/ProductsPolicyXResponse'
        - type: object
          properties:
            offerIds:
              type: array
              items:
                type: string
                format: uuid
        - type: object
          properties:
            type:
              type: string
              const: EXCLUDED
      required:
        - offerIds
      title: Excluded Products
    com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.SelectedProducts:
      allOf:
        - $ref: '#/components/schemas/ProductsPolicyXResponse'
        - type: object
          properties:
            offerIds:
              type: array
              items:
                type: string
                format: uuid
        - type: object
          properties:
            type:
              type: string
              const: SELECTED
      required:
        - offerIds
      title: Selected Products
    ShippingPolicyXResponse:
      discriminator:
        propertyName: type
        mapping:
          ALL_WINNER:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllWinner
          ALL_CREATOR:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.AllCreator
          MAX_CREATOR:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ShippingPolicyXResponse.MaxCreator
      properties:
        type:
          type: string
      required:
        - type
      title: Shipping Policy X Response
    ProductsPolicyXResponse:
      discriminator:
        propertyName: type
        mapping:
          ALL:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.AllProducts
          SELECTED:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.SelectedProducts
          EXCLUDED:
            $ref: >-
              #/components/schemas/com.fourthwall.app.openapi.endpoint.ProductsPolicyXResponse.ExcludedProducts
      properties:
        type:
          type: string
      required:
        - type
      title: Products Policy X Response
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: >-
            https://auth.staging.fourthwall.com/auth/realms/Fourthwall/protocol/openid-connect/auth
          scopes:
            donation_read: donation_read
            order_read: order_read
            order_write: order_write
            fulfillment_write: fulfillment_write
            giveaway_read: giveaway_read
            giveaway_write: giveaway_write
            memberships_read: memberships_read
            memberships_write: memberships_write
            promotions_write: promotions_write
            promotions_read: promotions_read
            offer_read: offer_read
            offer_write: offer_write
            shop_read: shop_read
            thankyou_read: thankyou_read
            thankyou_write: thankyou_write
            webhook_read: webhook_read
            webhook_write: webhook_write
            media_read: media_read
            media_write: media_write
            analytics_read: analytics_read
            samples_read: samples_read
            samples_write: samples_write
            dns_read: dns_read
            dns_write: dns_write
            settings_read: settings_read
            payout_read: payout_read
            integrations_read: integrations_read
    basicAuth:
      type: http
      scheme: basic

````