> ## Documentation Index
> Fetch the complete documentation index at: https://scaleup-c34c4386.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/v1/checkout-links/

> Retorna uma lista paginada de links de checkout

Lista links de checkout. Com **OAT da organização pai** (marketplace), você pode listar links da **própria org** e de **todas as sub-organizações diretas** vinculadas em `organization_relationships`, sem usar o token do filho.

Veja exemplos completos em [Marketplace: OAT da organização pai e sub-organizações](https://scaleup-c34c4386.mintlify.site/guides/parent-marketplace-suborganizations.md).

## Autenticação

Requer **Organization Access Token (OAT)** ou sessão de usuário com escopos adequados (`checkout_links:read` ou `checkout_links:write`, etc.).

## Parâmetros de Query

**organization\_id** `string`

**OAT de sub-organização / org única:** filtra por uma organização (comportamento clássico).

**OAT da organização pai:** opcional. Se **omitido**, a resposta inclui links cuja `organization_id` é a org do token **ou** qualquer **filho direto**. Se **informado**, deve ser o UUID da **própria org do token** ou de uma **sub-organização** da qual o token é pai direto; caso contrário retorna `403`.

**page** `integer` (default: 1)

Número da página

**limit** `integer` (default: 100)

Itens por página (máx: 100)

**sort\_by** `string` (default: created\_at)

Campo de ordenação: `created_at` ou `modified_at`

**sort\_order** `string` (default: desc)

`asc` ou `desc`

**product\_id** `string`

Filtra links associados a este produto (após o join interno)

**is\_archived** `boolean`

Quando `true`, lista links arquivados

## Resposta

**items** `array`

Lista de objetos de checkout link

**pagination** `object`

**Propriedades**

**total\_count** `integer`

Número total de itens

**max\_page** `integer`

Número máximo de páginas

## Exemplo

```bash cURL theme={null}
curl -X GET "https://api.chargefy.io/api/v1/checkout-links/?page=1&limit=10" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"
```

```typescript SDK theme={null}
import { Chargefy } from '@chargefy/sdk';

const chargefy = new Chargefy({
  accessToken: process.env.CHARGEFY_ACCESS_TOKEN,
});

// OAT marketplace: todos os links (pai + sub-orgs)
const all = await chargefy.checkoutLinks.list({ page: 1, limit: 50 });

// Apenas uma sub-organização
const childOrgId = process.env.CHILD_ORG_ID!;
const scoped = await chargefy.checkoutLinks.list({
  organizationId: childOrgId,
  page: 1,
  limit: 20,
});
```

## Resposta de Exemplo

```json theme={null}
{
  "items": [
    {
      "id": "clink_abc123",
      "label": "Link Plano Pro",
      "url": "https://pay.chargefy.io/clink_abc123",
      "product_ids": ["prod_123"],
      "discount_id": null,
      "success_url": "https://meusite.com/obrigado",
      "cancel_url": null,
      "metadata": {},
      "created_at": "2026-03-10T14:00:00Z",
      "updated_at": "2026-03-10T14:00:00Z"
    }
  ],
  "pagination": {
    "total_count": 5,
    "max_page": 1
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.