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

{
  "success": true,
  "message": "Lista de links de pagamento",
  "data": {
    "items": [
      {
        "id": "clx_link",
        "name": "Plano Pro",
        "slug": "plano-pro",
        "publicCode": "abc12",
        "status": "ACTIVE",
        "payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}
URL: GET https://api.goatpay.com.br/v1/payment-links/list · Permissão: payment-links/list
curl 'https://api.goatpay.com.br/v1/payment-links/list?page=1&status=ACTIVE' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Lista de links de pagamento",
  "data": {
    "items": [
      {
        "id": "clx_link",
        "name": "Plano Pro",
        "slug": "plano-pro",
        "publicCode": "abc12",
        "status": "ACTIVE",
        "payPageUrl": "https://pay.goatpay.com.br/pay/abc12/plano-pro"
      }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 1,
    "pages": 1
  },
  "requestId": "req_abc"
}

​
Query

​
page
number
Página (padrão 1).
​
pageSize
number
Itens por página (máx. 100).
​
status
string
ACTIVE ou INACTIVE.
​
search
string
Nome, slug ou publicCode.
Guia: Links de pagamento.

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
enum<string>
Available options:
ACTIVE,
INACTIVE

Response

200 - application/json

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

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