> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rightfoot.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Schedule Details

> Retrieve details about a scheduled balance request

# Retrieve Schedule Details

Retrieve details about a scheduled balance request, including when it last ran, when it will run next, and how many authorizers are included in the schedule.

## Use Cases

* Monitor the status of your scheduled balance requests
* Verify when the next balance check will occur
* Check how many authorizers are being tracked

## Response Fields

| Field               | Description                                                |
| ------------------- | ---------------------------------------------------------- |
| `schedule_id`       | The unique identifier for the schedule                     |
| `name`              | The name of the schedule, if one was provided              |
| `last_run_at`       | When the schedule last completed a run (null if never run) |
| `next_run_at`       | When the next scheduled run will occur                     |
| `total_authorizers` | Number of authorizers in this schedule                     |


## OpenAPI

````yaml GET /v1/monitoring/schedules/{id}
openapi: 3.1.0
info:
  title: Rightfoot API
  description: >-
    Submit a batch of authorizers for balance checks, retrieve processed
    balances, and check the status of a batch.
  version: 0.3.0-alpha
servers:
  - url: https://api.rightfoot.com
security:
  - BearerAuth: []
tags:
  - name: General Availability
    description: |
      **General Availability** indicates that the endpoint is production-ready.
  - name: Early Access
    description: >
      **Early Access** indicates that the endpoint is available for early access
      customers and is being actively refined.
  - name: In Development
    description: >
      **In Development** indicates that the endpoint is currently being built
      and will be available in an upcoming release.
paths:
  /v1/monitoring/schedules/{id}:
    get:
      tags:
        - General Availability
      summary: Get schedule details
      description: >
        Retrieve details about a scheduled balance request, including the last
        run time, next scheduled run, and total number of authorizers in the
        schedule.
      operationId: get_schedule_details
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            The schedule ID (UUID) returned when creating the scheduled balance
            request.
      responses:
        '200':
          description: Schedule details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleDetailsResponse'
              example:
                schedule_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                name: Weekly Balance Check
                last_run_at: '2024-12-12T02:30:00Z'
                next_run_at: '2024-12-19T02:30:00Z'
                total_authorizers: 150
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                status: error
                status_code: 404
                error:
                  code: NOT_FOUND
                  message: Schedule with the provided ID does not exist.
                  timestamp: '2024-12-12T12:00:00Z'
                  suggestion: Please check the schedule ID.
                documentation_url: https://api.rightfoot.com/docs
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ScheduleDetailsResponse:
      type: object
      properties:
        schedule_id:
          type: string
          format: uuid
          description: Unique identifier for the schedule.
        name:
          type: string
          description: The name of the schedule.
        last_run_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            ISO 8601 timestamp of the last completed run. Null if the schedule
            has not run yet.
        next_run_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the next scheduled run.
        total_authorizers:
          type: integer
          description: Total number of authorizers in this schedule.
      required:
        - schedule_id
        - name
        - next_run_at
        - total_authorizers
    ApiErrorResponse:
      type: object
      properties:
        status:
          type: string
          description: Status of the error, either "error" or "success"
        status_code:
          type: integer
          description: HTTP status code of the error
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code (e.g., "RESOURCE_NOT_FOUND")
            message:
              type: string
              description: Detailed error message.
            details:
              type: string
              description: Additional details about the error
            timestamp:
              type: string
              format: date-time
              description: Time the error occurred
            suggestion:
              type: string
              description: Suggested action to resolve the error
        documentation_url:
          type: string
          format: uri
          description: URL to the documentation for the error
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
          example:
            status: error
            status_code: 401
            error:
              code: UNAUTHORIZED
              message: Invalid API key provided.
              timestamp: '2024-09-16T12:01:00Z'
              suggestion: Please check your API key.
            documentation_url: https://api.rightfoot.com/docs
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
          example:
            status: error
            status_code: 500
            error:
              code: INTERNAL_SERVER_ERROR
              message: An unexpected error occurred while retrieving the balances.
              timestamp: '2024-09-16T12:11:00Z'
              suggestion: >-
                Please try again later. If the problem persists, contact our
                support team.
            documentation_url: https://api.rightfoot.com/docs
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Authentication to the API is performed via Bearer Token Authentication.
        Provide your API key as the bearer token in the Authorization header.


        All API requests must be made over HTTPS. Calls made over plain HTTP
        will fail. API requests without authentication will also fail.

````