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 Driver Volunteering Periods API

API endpoints for fetching volunteering periods for drivers - i.e. periods where a driver is willing to volunteer for extra work, such as on a rest day or for overtime.

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

Tagged areas include Driver Volunteering Periods. 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 22 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 22 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 Driver Volunteering Periods 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.

Driver Volunteering Periods 1

API endpoints for fetching volunteering periods for drivers - i.e. periods where a driver is willing to volunteer for extra work, such as on a rest day or for overtime.

GET
/v1/drivers/volunteering-periods
List driver volunteering periods
GetVolunteeringPeriods 4 params → 200400404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are DriverVolunteerPeriodBase (8 properties), TypedErrorResponse_Invalidrequestschema_ (3 properties), Pagination (3 properties), Partial_Record_keyofDriverVolunteerPeriodTimeRange.null__ (3 properties). Each schema is shown below with its type and property counts.

TypedApiErrorResponse_Invalidrequestschema_
object
1 property 1 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…
UUID
string
Stringified ID for a resource. Cannot exceed 36 characters.
TypedErrorResponse_Invalidrequestschema_
object
3 properties 2 required
Pagination
object
Metadata about the pagination of a list of items. When a list of items is too large to be returned in a single response, it is split into multiple pages. This…
3 properties 2 required
PageNumber
Page number (1-indexed). Defaults to 1.
DriverVolunteerPeriodBase
object
Base properties for a volunteer period A volunteer period is a period that the driver is willing to volunteer for. It can volunteering on a rest day or overtim…
8 properties 6 required
WeekDay
number
DriverVolunteerPeriodTimeRange
object
3 properties 3 required
GetVolunteeringPeriodsSuccessfulResponse
object
Paginated response containing driver volunteering periods
2 properties 2 required
TypedErrorResponse_GetVolunteeringPeriodsErrorTypes_
object
3 properties 2 required
PartialRecord_keyofDriverVolunteerPeriodTimeRange.null_
Integer
integer
VolunteerType
string
GetVolunteeringPeriodsErrorTypes
string
GetVolunteeringPeriodsErrorResponse
Partial_Record_keyofDriverVolunteerPeriodTimeRange.null__
object
Make all properties in T optional
3 properties
StringifyDate
string
Stringified ISO8601 date in the form of YYYY-MM-dd, for example 2017-07-21
SchemaValidationErrorResponse
TypedApiErrorResponse_GetVolunteeringPeriodsErrorTypes_
object
1 property 1 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…
DriverVolunteerPeriod
A volunteer period can have a time period which will include a start time, end time and a code. Either all properties (startTime, endTime, timePeriodCode) are…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optibus-driver-volunteering-periods-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 Drivers API
Optibus Drivers (Deprecated) API
Optibus Event Webhooks API
Optibus Operational Plan API
Optibus Operational Plan (Deprecated) API
Optibus Payroll API
Optibus Preferences API
Where this information came from

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