How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Schedules API

The Schedules API from Orum — 3 operation(s) for schedules.

Orum Schedules API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Schedules. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

5 operations 3 paths 22 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Schedules API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Schedules 5
POST
/deliver/schedules
Create a schedule
post-schedule 1 param body → 200400default
GET
/deliver/schedules
Get all schedules
get-schedules 4 params → 200400default
POST
/deliver/schedules/rrule
Validate and parse RRULE string
post-validate-rrule 1 param body → 200400default
GET
/deliver/schedules/{id}
Get schedule by id
get-schedule 2 params → 200404default
DELETE
/deliver/schedules/{id}
delete a schedule that matches the id
delete-schedule 2 params → 200404default

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ScheduleResponseBaseObject (14 properties), ScheduleRequest (8 properties), RruleValidationResponse (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

ScheduleRequest
object
8 properties 6 required
CreatedAt
string
Timestamp when the resource was created.
SchedulesResponse
object
1 property 1 required
UpdatedAt
string
Timestamp when the resource was last updated.
Currency
string
Currency code in ISO 4217 format. Only USD is supported.
ScheduleNextPaymentDate
string
The date when the schedule will execute
TransferSpeed
string
Speed of transfer.
DestinationTransferParty
object
Information about the transfer funds destination, which will be credited.
3 properties 2 required
TransferAmount
integer
Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
SourceTransferParty
object
For use cases that require a Source, information about the transfer funding source, which will be debited.
3 properties 2 required
ScheduleReferenceId
string
Unique reference id for the Schedule. Generated by you.
ScheduleResponseBaseObject
object
14 properties 12 required
RruleValidationResponse
object
4 properties 5 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
ScheduleResponse
object
1 property 1 required
ScheduleRecurrence
string
Recurrence of the schedule in iCalendar RRULE format
OrumId
string
Orum generated unique id for the resource.
ScheduleStatus
string
Describes the current status of the schedule.
ScheduleHumanReadableCadence
string
The human-readable cadence of the schedule.
ScheduleStartDate
string
The date when the schedule starts, in YYYY-MM-DD format.
ErrorResponse
object
3 properties 2 required
RruleValidationRequest
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-schedules-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

This is an independent, third-party profile of Orum Schedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.