Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Teachworks Other Events API

Non-teaching calendar events.

Teachworks Other Events API is one of 23 APIs that Teachworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.teachworks.com/v1.

2 operations 2 paths 1 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.teachworks.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Teachworks Other Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Account API token passed in the Authorization header using the scheme "Authorization: Token token=APITOKEN". Generate a token on the Integrations and Add-ons p…

Paths & Operations 2

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

Other Events 2

Non-teaching calendar events.

GET
/other_events
List all Other Events
listOtherEvents 2 params → 200401
GET
/other_events/{id}
Retrieve an Other Event
getOtherEvent 1 param → 200401404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teachworks-other-events-api-openapi.yml Raw ↑

Other APIs Teachworks publishes across the network.

Teachworks Availabilities API
Teachworks Cost Premiums API
Teachworks Credit Note Allocations API
Teachworks Customers API
Teachworks Employees API
Teachworks Invoices API
Teachworks Lesson Participants API
Teachworks Lessons API
Teachworks Locations API
Teachworks Other Compensation API
Teachworks Payment Allocations API
Teachworks Payments API