Skip to main content
GET
/
api
/
v1
/
pix-keys
curl -X GET 'https://app.plowf.com/api/v1/pix-keys?type=EMAIL&is_active=true' \
  -H 'Authorization: Bearer seu_token_aqui'
{
  "data": [
    {
      "key": "[email protected]",
      "type": "EMAIL",
      "is_active": true,
      "created_at": "2026-01-19T19:32:14.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "total": 1,
    "per_page": 10
  }
}
Lista todas as chaves PIX da conta autenticada com suporte a filtros e paginação.
curl -X GET 'https://app.plowf.com/api/v1/pix-keys?type=EMAIL&is_active=true' \
  -H 'Authorization: Bearer seu_token_aqui'

Parâmetros de Query

Todos os parâmetros são opcionais.
type
string
Tipo da chave PIX. Valores possíveis: DOCUMENT, EMAIL, PHONE, RANDOM
is_active
boolean
Filtrar por status da chave. true para ativas, false para inativas.
per_page
integer
default:"10"
Número de itens por página (mínimo: 1, máximo: 100)

Resposta de Sucesso

{
  "data": [
    {
      "key": "[email protected]",
      "type": "EMAIL",
      "is_active": true,
      "created_at": "2026-01-19T19:32:14.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "total": 1,
    "per_page": 10
  }
}
data
object[]
meta
object
Metadados de paginação

Erros Comuns