> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List Pix Automático schedules > Lists live upstream scheduled payment instructions, scoped by flow + due-date window, projecting each onto the local schedule status. The response is an object wrapper carrying the upstream timestamp and the schedule snapshots. ## OpenAPI ````yaml en/openapi/v3-current/pix.yaml GET /v1/pix-automatico/schedules/list openapi: 3.0.3 info: title: Plugin BR Pix Direct - Complete API description: | Complete API for Brazilian Pix instant payment system including Pix key dictionary operations, QR code generation/decoding, transactions and transaction limits. version: 1.0.0 servers: - url: https://plugin-pix-direct.api.lerian.net - url: https://plugin-pix-direct-qrcode.api.lerian.net security: - bearerAuth: [] paths: /v1/pix-automatico/schedules/list: get: tags: - Pix Automático API summary: List Pix Automático schedules description: >- Lists live upstream scheduled payment instructions, scoped by flow + due-date window, projecting each onto the local schedule status. The response is an object wrapper carrying the upstream timestamp and the schedule snapshots. parameters: - description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador). explode: false in: query name: flow schema: description: fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador). format: int64 type: integer - description: cnpjRecebedor filter (string). explode: false in: query name: recipientCnpj schema: description: cnpjRecebedor filter (string). type: string - description: tpPessoaPagador filter (0/1; empty = no filter). explode: false in: query name: payerPersonType schema: description: tpPessoaPagador filter (0/1; empty = no filter). type: string - description: cpfCnpjPagador filter (string). explode: false in: query name: payerDocument schema: description: cpfCnpjPagador filter (string). type: string - description: nrAgenciaPagador filter (string). explode: false in: query name: payerAgency schema: description: nrAgenciaPagador filter (string). type: string - description: nrContaPagador filter (string). explode: false in: query name: payerAccount schema: description: nrContaPagador filter (string). type: string - description: stAgendamento filter (0/1; empty = no filter). explode: false in: query name: scheduleStatus schema: description: stAgendamento filter (0/1; empty = no filter). type: string - description: dtVencimentoInicio (aaaa-mm-dd). explode: false in: query name: dueDateFrom schema: description: dtVencimentoInicio (aaaa-mm-dd). type: string - description: dtVencimentoFim (aaaa-mm-dd). explode: false in: query name: dueDateTo schema: description: dtVencimentoFim (aaaa-mm-dd). type: string - description: pagina (default 1). explode: false in: query name: page schema: description: pagina (default 1). format: int64 type: integer - description: tamanhoPagina (default 50, max 100). explode: false in: query name: pageSize schema: description: tamanhoPagina (default 50, max 100). format: int64 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListSchedulesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: ListSchedulesResponse: additionalProperties: false properties: jdPiAt: description: Upstream response timestamp (upstream timestamp, UTC). type: string schedules: description: The matching schedule snapshots (agendamentos). items: $ref: '#/components/schemas/ScheduleResponse' type: array nullable: true required: - jdPiAt - schedules type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: array nullable: true instance: description: >- A URI reference that identifies the specific occurrence of the problem. format: uri type: string status: description: HTTP status code format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. format: uri type: string type: object ScheduleResponse: additionalProperties: false properties: acceptRejectAt: description: Accept/reject timestamp (dtHrAceiteRejeite, UTC). type: string amount: description: Scheduled amount in reais. format: double type: number cancellations: description: Cancellation history (cancelamento). items: $ref: '#/components/schemas/ScheduleCancellationItem' type: array nullable: true debtor: $ref: '#/components/schemas/ScheduleDebtorView' dueDate: description: Due date (aaaa-mm-dd). type: string endToEndId: description: The payment-transaction id (32-char). type: string errorCode: description: Upstream error code. type: string errorDesc: description: Upstream error description. type: string idRecorrencia: description: The recurrence id (RR...). type: string infoBetweenClients: description: Free-text receiver-to-payer info. type: string localStatus: description: Local ScheduleStatus projected from the upstream situation. type: string localStatusKnown: description: False when the upstream situation carries no projected local status. type: boolean payer: $ref: '#/components/schemas/ScheduleParty' purpose: description: finalidadeAgendamento. format: int64 type: integer recipient: $ref: '#/components/schemas/ScheduleParty' recipientReceivedAt: description: Recipient PSP reception timestamp (UTC). type: string reconciliationId: description: The receiver conciliation id. type: string requestedAt: description: Upstream request timestamp (UTC). type: string scheduleStatus: description: stAgendamento (0=Aceito, 1=Rejeitado; -1 when absent). format: int64 type: integer situationAt: description: Situation timestamp (dtHrSituacao, UTC). type: string stJdPi: description: Upstream overall situation (-1/0/9/10/11). format: int64 type: integer stJdPiProc: description: Upstream intermediate situation (0/1/2/5/7/8/9/10/11). format: int64 type: integer required: - endToEndId - idRecorrencia - scheduleStatus - stJdPiProc - stJdPi - localStatus - localStatusKnown - recipient - payer - debtor type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object ScheduleCancellationItem: additionalProperties: false properties: cancelStatus: description: stCancelamento (0=Aceito, 1=Rejeitado; -1 when absent). format: int64 type: integer cancelledAt: description: Cancellation timestamp (UTC). type: string errorCode: description: Upstream error code (codigoErro). type: string errorDesc: description: Upstream error description (descCodigoErro). type: string idCancelamento: description: The cancellation id (29-char, CA...). type: string reason: description: motivoCancelamento (0..6). format: int64 type: integer recipientIspb: description: ispbDestinatario (string). type: string requesterDocument: description: Requester CPF/CNPJ (string). type: string requesterIspb: description: ispbSolicitante (string). type: string requesterType: description: tpPessoaSol. format: int64 type: integer required: - idCancelamento - requesterIspb - recipientIspb - requesterType - requesterDocument - reason - cancelledAt - cancelStatus type: object ScheduleDebtorView: additionalProperties: false properties: cpfCnpj: description: Debtor CPF/CNPJ (string). type: string name: description: Debtor name. type: string personType: description: tpPessoa. format: int64 type: integer type: object ScheduleParty: additionalProperties: false properties: account: description: Account number (nrConta, string). type: string accountType: description: tpConta. format: int64 type: integer agency: description: Branch (nrAgencia, string). type: string cnpj: description: CNPJ (string). type: string cpfCnpj: description: CPF/CNPJ (string). type: string ispb: description: Participant ISPB (string). type: string name: description: Legal/trade name. type: string personType: description: tpPessoa. format: int64 type: integer type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > JWT Bearer token authentication. Obtain token from `/v1/login/oauth/access_token` endpoint using client credentials (clientId and clientSecret). Include token in Authorization header: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` Token expires after 3600 seconds (1 hour). ````