Skip to main content
GET
/
links
Listar links
curl --request GET \
  --url https://api.pagozz.com/v1/links \
  --header 'Pagozz-Token: <api-key>'
{
  "data": {
    "links": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Consultoria 1h",
        "description": "Sessão de consultoria individual",
        "value_mode": "fixed",
        "amount": 15000,
        "min_amount": null,
        "currency": "BRL",
        "status": "active",
        "payment_methods": [
          "pix"
        ],
        "environment": "test",
        "created_at": "2026-02-20T10:30:00Z",
        "updated_at": "2026-02-20T10:30:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}

Authorizations

Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Query Parameters

status
enum<string>

Filtrar por status do link.

Available options:
active,
inactive
page
integer
default:1

Número da página (começa em 1).

page_size
integer
default:20

Quantidade de itens por página (máximo 100).

Required range: x <= 100

Response

Lista de links retornada com sucesso.

data
object