> ## 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.

# Obter um agendamento

> Use este endpoint para recuperar um agendamento de conciliação específico pelo seu identificador.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/schedules/{scheduleId}
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Lerian Studio General License
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/contexts/{contextId}/schedules/{scheduleId}:
    get:
      tags:
        - Configuration Schedules
      summary: Obter um agendamento
      description: >-
        Use este endpoint para recuperar um agendamento de conciliação
        específico pelo seu identificador.
      operationId: getSchedule
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The unique identifier of the reconciliation context.
          in: path
          name: contextId
          required: true
          schema:
            type: string
        - description: The unique identifier of the schedule.
          in: path
          name: scheduleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Detalhes do agendamento
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleResponse'
        '400':
          description: A requisição contém parâmetros ou payload inválidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0001:
                  $ref: '#/components/examples/ErrorM0001'
        '401':
          description: A requisição não contém credenciais de autenticação válidas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Você não tem permissão para acessar este recurso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Agendamento não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Ocorreu um erro inesperado no servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ScheduleResponse:
      description: Agenda de conciliação baseada em cron
      properties:
        id:
          description: Identificador único da agenda
          example: 019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b
          format: uuid
          type: string
        contextId:
          description: Contexto ao qual esta agenda pertence
          example: 019c96a0-2a10-7dfe-b5c1-8a1b2c3d4e5f
          format: uuid
          type: string
        cronExpression:
          description: Expressão cron que define a agenda
          example: 0 0 * * *
          maxLength: 100
          type: string
        enabled:
          description: Indica se a agenda está ativa
          example: true
          type: boolean
        lastRunAt:
          description: Horário da última execução bem-sucedida no formato RFC 3339
          example: '2025-01-15T10:30:00Z'
          format: date-time
          type: string
        nextRunAt:
          description: Horário da próxima execução agendada no formato RFC 3339
          example: '2025-01-16T00:00:00Z'
          format: date-time
          type: string
        createdAt:
          description: Timestamp de criação no formato RFC 3339
          example: '2025-01-15T10:30:00Z'
          format: date-time
          type: string
        updatedAt:
          description: Timestamp da última atualização no formato RFC 3339
          example: '2025-01-15T10:30:00Z'
          format: date-time
          type: string
      type: object
    ErrorResponse:
      description: Resposta de erro padrão retornada por todos os endpoints da API
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Código de erro de aplicação estável.
          example: MTCH-0001
        title:
          type: string
          description: Título de erro legível por humanos.
          example: Bad Request
        message:
          type: string
          description: Mensagem de erro legível com detalhes.
          example: context not found
        error:
          type: string
          description: Descontinuado. Mensagem de erro para compatibilidade retroativa.
          deprecated: true
        details:
          description: Contexto adicional do erro como pares chave-valor
          additionalProperties: {}
          type: object
  examples:
    ErrorM0001:
      summary: Bad Request
      value:
        code: MTCH-0001
        title: Bad Request
        message: >-
          The request contains invalid parameters or malformed syntax. Please
          check your request and try again.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````