GET
/
deliver
/
schedules
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "schedules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "schedule_reference_id": "<string>",
      "status": "active",
      "amount": 2,
      "currency": "USD",
      "speed": "asap",
      "source": {
        "customer_reference_id": "<string>",
        "account_reference_id": "<string>",
        "statement_display_name": "<string>"
      },
      "destination": {
        "customer_reference_id": "<string>",
        "account_reference_id": "<string>",
        "statement_display_name": "<string>"
      },
      "start_date": "2025-01-01",
      "recurrence": "RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR",
      "next_payment_date": "2025-01-01",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "rrule_readable": "Weekly on Monday, Wednesday, and Friday"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver API. Use v2022-09-21.

Available options:
v2022-09-21

Query Parameters

​
index
integer
default:0

Index for paginated results

Required range: x >= 0
​
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500
​
status
enum<string>

Filter results by schedule status

Available options:
active,
inactive

Response

200
application/json

200 response.

The response is of type object.