# Listar programações

Consulte as programações da sua carteira.

GET`/transfer-scheduled/list`

Try it

## Autorização

[X-API-Key](#auth-X-API-Key)stringrequired

Chave VibeCash com permissão para esta operação.

## Resposta

200 application/json

[success](#response-success)booleanrequired

Indica se a operação foi concluída pela API.

[message](#response-message)stringrequired

Mensagem da operação.

[data](#response-data)objectrequired

Dados retornados pela operação.

Show child attributes[items](#response-data-items)array

Itens da consulta.

[total](#response-data-total)integer

Quantidade de itens, quando a rota oferece paginação.

[page](#response-data-page)integer

Página atual.

[pageSize](#response-data-pageSize)integer

Itens por página.

[requestId](#response-requestId)string

Identificador da requisição.

## Execução e estados

Programações dependem do serviço de execução ativo e de dois fatores habilitado na conta. Estados: `active`, `paused`, `processing`, `completed`, `failed` e `canceled`.

Recorrências aceitam `daily`, `weekly`, `monthly` e `custom_days`, no fuso `America/Sao_Paulo`. Em `custom_days`, informe `customDays` como lista dos dias da semana: 0 (domingo) a 6 (sábado).

## Erros

As falhas retornam o envelope com `success: false`. Consulte [erros e códigos HTTP](/docs/api-reference/guides/errors) para interpretar validação, permissão, conflito e saldo insuficiente.

## Exemplo de requisição

```bash
curl --request GET \
  --url 'https://seu-dominio/v1/transfer-scheduled/list' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
```

## Exemplo de resposta

```json
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "items": [
      {
        "id": "schedule_exemplo",
        "label": "Pagamento programado",
        "amount": 5,
        "method": "PIX",
        "destination": "recebedor@exemplo.com",
        "status": "active",
        "triggerType": "once",
        "nextRunAt": "2030-12-01T15:00:00.000Z",
        "lastRunAt": null,
        "runCount": 0,
        "maxRuns": null,
        "lastError": null
      }
    ]
  },
  "requestId": "req_exemplo"
}
```
