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 Employment Periods API

API endpoints for managing employment periods for drivers - i.e. periods where they are employed, hired, terminated, etc.

Optibus Driver Employment 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 Employment Periods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 26 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.

3 operations 3 paths 26 schemas 1 GET1 POST1 PUT

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 Employment Periods API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key).

Paths & Operations 3

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

Driver Employment Periods 3

API endpoints for managing employment periods for drivers - i.e. periods where they are employed, hired, terminated, etc.

GET
/v2/drivers/employment-periods
List driver employment periods
GetEmploymentPeriodsV2 4 params → 200400404
POST
/v1/drivers/employment-periods
Create driver employment period
PostDriverEmploymentPeriods body → 201400409422
PUT
/v1/drivers/employment-periods/{periodId}
Update driver employment period
PutDriverEmploymentPeriodById 1 param body → 200400404409422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are PutDriverEmploymentPeriodsRequest (4 properties), PostDriverEmploymentPeriodsRequest (4 properties), EmploymentPeriodV2 (4 properties), TypedErrorResponse_PostDriverEmploymentPeriodsErrorTypes_ (3 properties). Each schema is shown below with its type and property counts.

TypedApiErrorResponse_Invalidrequestschema_
object
1 property 1 required
TypedErrorResponse_PutDriverEmploymentPeriodsErrorTypes_
object
3 properties 2 required
GetEmploymentPeriodsV2SuccessfulResponse
object
Paginated response containing driver employment periods
2 properties 2 required
PutDriverEmploymentPeriodsWarning
object
2 properties 2 required
PutDriverEmploymentPeriodsSuccess
object
1 property
TypedErrorResponse_GetEmploymentPeriodsV2ErrorTypes_
object
3 properties 2 required
PostDriverEmploymentPeriodsErrorResponse
TypedErrorResponse_Invalidrequestschema_
object
3 properties 2 required
EmploymentPeriodV2
object
A single driver employment period record in the V2 response format
4 properties 3 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
TypedApiErrorResponse_PostDriverEmploymentPeriodsErrorTypes_
object
1 property 1 required
PageNumber
Page number (1-indexed). Defaults to 1.
TypedErrorResponse_PostDriverEmploymentPeriodsErrorTypes_
object
3 properties 2 required
TypedApiErrorResponse_GetEmploymentPeriodsV2ErrorTypes_
object
1 property 1 required
PostDriverEmploymentPeriodsSuccess
GetEmploymentPeriodsV2ErrorTypes
string
PostDriverEmploymentPeriodsErrorTypes
string
TypedApiErrorResponse_PutDriverEmploymentPeriodsErrorTypes_
object
1 property 1 required
PutDriverEmploymentPeriodsErrorTypes
string
PutDriverEmploymentPeriodsErrorResponse
Integer
integer
PutDriverEmploymentPeriodsRequest
object
4 properties 3 required
StringifyDate
string
Stringified ISO8601 date in the form of YYYY-MM-dd, for example 2017-07-21
SchemaValidationErrorResponse
PostDriverEmploymentPeriodsRequest
object
4 properties 2 required
GetEmploymentPeriodsV2ErrorResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optibus-driver-employment-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 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
Optibus Preferences API
Where this information came from

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