Skip to main content
GET
/
v1
/
coupons
List coupons
curl --request GET \
  --url https://api.example.com/v1/coupons
{
  "data": [
    {
      "name": "PARTNERO25",
      "uuid_code": "coupon_123",
      "active": true,
      "coupon_discount_type": "percent",
      "coupon_discount_amount": 25,
      "coupon_duration_type": "months",
      "coupon_duration_value": 11,
      "redemption_specific_date_status": false,
      "redemption_specific_date_value": null,
      "redemption_times_status": true,
      "redemption_times_value": 24,
      "promotion_codes": {
        "data": []
      },
      "metadata": [],
      "additional_info": [],
      "times_redeemed": 3,
      "created_at": "2025-05-07T17:43:26.000000Z",
      "updated_at": "2025-05-07T17:43:26.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/coupons?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/coupons",
    "per_page": 10,
    "to": 1
  },
  "status": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.partnero.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET https://api.partnero.com/v1/coupons

​
Query Parameters

ParameterTypeDefaultDescription
limitinteger15Number of results per page (1-250)
pageinteger1Page number for pagination

​
Request

cURL
curl --location 'https://api.partnero.com/v1/coupons' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

{
  "data": [
    {
      "name": "PARTNERO25",
      "uuid_code": "coupon_123",
      "active": true,
      "coupon_discount_type": "percent",
      "coupon_discount_amount": 25,
      "coupon_duration_type": "months",
      "coupon_duration_value": 11,
      "redemption_specific_date_status": false,
      "redemption_specific_date_value": null,
      "redemption_times_status": true,
      "redemption_times_value": 24,
      "promotion_codes": {
        "data": []
      },
      "metadata": [],
      "additional_info": [],
      "times_redeemed": 3,
      "created_at": "2025-05-07T17:43:26.000000Z",
      "updated_at": "2025-05-07T17:43:26.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/coupons?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/coupons",
    "per_page": 10,
    "to": 1
  },
  "status": 1
}

​
Response Fields

FieldTypeDescription
data[].namestringCustomer-facing coupon name
data[].uuid_codestringUnique coupon identifier
data[].activebooleanWhether coupon is active
data[].coupon_discount_typestringpercent or static
data[].coupon_discount_amountnumberDiscount amount or percentage
data[].coupon_duration_typestringonce, hours, days, months, years, lifetime
data[].coupon_duration_valueintegerDuration value
data[].promotion_codesobjectAssociated promotion codes
data[].metadataobjectCustom key-value pairs
data[].times_redeemedintegerTotal number of redemptions
data[].additional_infoobjectInternal data, including a redemptions log when redemptions are recorded via the API