Skip to main content
GET
/
coupons
/
list
curl 'https://api.goatpay.com.br/v1/coupons/list?page=1&search=VERAO' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Lista de cupons",
  "data": {
    "items": [{ "id": "clx_coupon", "code": "VERAO10", "discountType": "PERCENT", "discountValue": 10 }],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/coupons/list · Permissão: coupons/list
curl 'https://api.goatpay.com.br/v1/coupons/list?page=1&search=VERAO' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Lista de cupons",
  "data": {
    "items": [{ "id": "clx_coupon", "code": "VERAO10", "discountType": "PERCENT", "discountValue": 10 }],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}
​
page
number
Página.
​
pageSize
number
Tamanho (máx. 100).
​
search
string
Código do cupom.
​
status
string
Filtro de status quando aplicável.
Guia: Cupons.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:50
Required range: 1 <= x <= 100
​
search
string
​
status
string

Response

200 - application/json

Lista paginada (clientes, produtos, cupons ou links).

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string