Skip to main content
GET
/
v1
/
monitoring
/
schedules
/
{id}
Get schedule details
curl --request GET \
  --url https://api.rightfoot.com/v1/monitoring/schedules/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
}

​
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

FieldDescription
schedule_idThe unique identifier for the schedule
nameThe name of the schedule, if one was provided
last_run_atWhen the schedule last completed a run (null if never run)
next_run_atWhen the next scheduled run will occur
total_authorizersNumber of authorizers in this schedule

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
id
string<uuid>
required

The schedule ID (UUID) returned when creating the scheduled balance request.

Response

Schedule details retrieved successfully

​
schedule_id
string<uuid>
required

Unique identifier for the schedule.

​
name
string
required

The name of the schedule.

​
next_run_at
string<date-time>
required

ISO 8601 timestamp of the next scheduled run.

​
total_authorizers
integer
required

Total number of authorizers in this schedule.

​
last_run_at
string<date-time> | null

ISO 8601 timestamp of the last completed run. Null if the schedule has not run yet.