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

Optibus Roster API

A roster describes the daily operator runs grouped into packages of (repeating) weekly work assignments.

Optibus Roster API is one of 26 APIs that Optibus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Roster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 1 operation across 1 path, and defines 40 schemas. It is described by OpenAPI 3.0.0, at version 2.8.17.

Requests are made against a single base URL, https://YOUR-OPTIBUS-ACCOUNT.api.ops.optibus.co.

1 operations 1 paths 40 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.8.17
Base URL
https://your-optibus-account.api.ops.optibus.co
Authentication
API Key
License
Optibus Ltd, All rights reserved
Resource Areas
1

Authentication & Security 1

Optibus Roster API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Roster 1

A roster describes the daily operator runs grouped into packages of (repeating) weekly work assignments.

GET
/roster
Fetch roster
GetRoster 2 params → 200404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are RosterData (14 properties), RosterInfo (7 properties), StandbySummary (7 properties), BlockSummary (6 properties). Each schema is shown below with its type and property counts.

ReliefCarEventsTypes
string
RosterAssignments
object
5 properties 4 required
MinutesFromMidnightTime
integer
Wall clock time, represented as minutes since midnight. For example, 0 is midnight (start of the day), 120 is 02:00 (2 hours after midnight), 180 is 02:30 (2.5…
StandbySummary
object
7 properties 3 required
Spare
CustomScheduleEventsTypes
string
Duty schedule only custom event, vehicle does not move between stops
UUID
string
Stringified ID for a resource. Cannot exceed 36 characters.
RosterTaskType.Standby
string
RosterAssignmentType
string
RosterTimedTask
SpareSummary
object
4 properties 1 required
BaseRosterTask
object
3 properties 3 required
Block
object
5 properties 5 required
RosterStartDay
number
RosterData
object
14 properties 13 required
RosterInfo
object
7 properties 7 required
RosterLine
object
3 properties 3 required
Omit_RosterTimedTask.startTime-or-endTime_
Construct a type with the properties of T except for those in type K.
Standby
RosterTaskType.Spare
string
BlockSummary
object
6 properties 1 required
Duty
Task
OnScheduleEventsTypes
string
Minutes
integer
time measure in minutes
Stop
object
4 properties 2 required
DutySummary
DutySplit
object
2 properties 2 required
Integer
integer
RosterTaskType.Duty
string
RosterTaskType
string
RosterRotating
string
GenericRosterEvent
StringifyDate
string
Stringified ISO8601 date in the form of YYYY-MM-dd, for example 2017-07-21
OtherEventTypes
string
GenericRosterEventProps_unknown_
object
3 properties 3 required
StringifyDateTime
string
Stringified date-time. date-time notation as defined by [RFC 3339](https://tools.ietf.org/html/rfc3339section-5.6), section 5.6, for example,2017-07-21T17:32:2…
Pick_RosterTimedTask.Exclude_keyofRosterTimedTask.startTime-or-endTime__
object
From T, pick a set of properties whose keys are in the union K
5 properties 5 required
GetRosterResponse
ScheduleEventsType

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optibus-roster-api-openapi.yml Raw ↑

Other APIs Optibus publishes across the network.

Optibus Driver Absences API
Optibus Driver App Notifications API
Optibus Driver Custom Attributes API
Optibus Driver Employment Periods API
Optibus Driver Groups API
Optibus Driver Volunteering Periods API
Optibus Drivers API
Optibus Drivers (Deprecated) API
Optibus Event Webhooks API
Optibus Operational Plan API
Optibus Operational Plan (Deprecated) API
Optibus Payroll API
Where this information came from

This is an independent, third-party profile of Optibus Roster 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.