Skip to main content
Lista os links de onboarding pertencentes à organização autenticada. Cada link pode ser reutilizado infinitas vezes para incorporar o fluxo de onboarding de sub-organizações.

Autenticação

Requer Organization Access Token (OAT) ou sessão de usuário via header Authorization: Bearer.

Parâmetros de Query

organization_id
string
ID da organização pai. Obrigatório quando autenticado via sessão de usuário (não necessário com OAT).

Resposta

items
array
Lista de objetos de onboarding link

Exemplo

curl -X GET "https://api.chargefy.io/api/v1/onboarding-links/" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

Resposta de Exemplo

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "token": "obl_abc123xyz",
      "parent_organization_id": "org_abc123",
      "fee_percent": 5,
      "onboarding_options": {
        "send_invite": true
      },
      "created_at": "2026-03-20T10:00:00Z"
    }
  ]
}