Skip to content
Patrimoine
v9.1.0

List Endpoint

GET
/api/v1/funding-schedules
curl --request GET \
  --url 'https://example.com/api/v1/funding-schedules?limit=50&offset=0'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 250
offset
Offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Endpoint Api V1 Funding Schedules Get
Array<object>
FundingScheduleOut
object
id
required
Id
integer
name
required
Name
string
frequency
required
Frequency
string
repeat_every
required
Repeat Every
integer
day_of_week
required
Any of:
integer
day_of_month
required
Any of:
integer
second_day_of_month
required
Any of:
integer
month_of_year
required
Any of:
integer
start_date
required
Start Date
string format: date
weekend_shift
required
Weekend Shift
string
is_default
required
Is Default
boolean
next_date
required
Any of:
string format: date
usage_count
Usage Count
integer
0
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Example 

[
  {
    "usage_count": 0
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}