Skip to main content
GET
/
deliver
/
schedules
/
{id}
Get schedule by id
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/schedules/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "schedule": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "schedule_reference_id": "<string>",
    "status": "active",
    "amount": 2,
    "currency": "USD",
    "speed": "asap",
    "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",
    "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>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.orum.io/llms.txt

Use this file to discover all available pages before exploring further.

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 and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

id
string<uuid>
required

Orum generated unique id for the schedule you are fetching. Orum generated unique id for the resource.

Response

200 response.

schedule
object
required