Skip to main content
GET
URL: GET https://api.goatpay.com.br/v1/payment-links/list · Permissão: payment-links/list

Query

number
Página (padrão 1).
number
Itens por página (máx. 100).
string
ACTIVE ou INACTIVE.
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
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