Skip to main content
GET
/
api
/
campaigns
/
gifts
Get all gifts with pagination and filtering
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/gifts \
  --header 'x-api-key: <x-api-key>'
{
  "data": [
    {
      "giftId": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "price": 123,
      "currency": "<string>",
      "inventory": {
        "total": 123,
        "available": 123,
        "reserved": 123
      },
      "status": "available",
      "isDelightloop": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "shortDescription": "<string>",
      "description": "<string>",
      "imageUrls": [
        "<string>"
      ],
      "dimensions": {
        "height": 123,
        "width": 123,
        "length": 123,
        "unit": "inch"
      },
      "weight": {
        "weight": 123,
        "unit": "pound"
      }
    }
  ],
  "page": 123,
  "limit": 123,
  "total": 123,
  "totalPages": 123,
  "hasNext": true,
  "hasPrev": true
}

Headers

x-api-key
string
required

auth key

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:12

Number of items per page

Required range: 1 <= x <= 100

Search by gift name

collectionId
string

Filter by collection ID

isDelightloop
boolean

Filter by Delightloop gifts only

status
enum<string>

Filter by status

Available options:
available,
pending,
in_transit,
delivered

Response

200 - application/json

Gifts retrieved successfully

data
object[]
required

Array of gifts

page
number
required

Current page number

limit
number
required

Number of items per page

total
number
required

Total number of items

totalPages
number
required

Total number of pages

hasNext
boolean
required

Whether there is a next page

hasPrev
boolean
required

Whether there is a previous page