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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Teachworks

Teachworks Customers API

Billing accounts - families and independent students.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

7 operations 6 paths 1 schemas 3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Teachworks Customers 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 7

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

Customers 7

Billing accounts - families and independent students.

GET
/customers
List all Customers
listCustomers 4 params → 200401
GET
/customers/{id}
Retrieve a Customer
getCustomer 1 param → 200401404
PUT
/customers/{id}
Update a Customer (Family or Independent Student)
updateCustomer 1 param body → 200401422
GET
/customers/{id}/lesson_totals
Retrieve Customer Lesson Totals
getCustomerLessonTotals 1 param → 200401404
PUT
/customers/{id}/custom_fields
Set Custom Field Values
setCustomerCustomFields 1 param body → 200401422
POST
/customers/family
Create a Family
createFamily body → 200401422
POST
/customers/independent_student
Create an Independent Student
createIndependentStudent body → 200401422

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-customers-api-openapi.yml Raw ↑

Other APIs Teachworks publishes across the network.

Teachworks Availabilities API
AE Profile APIs.io
Teachworks Cost Premiums API
AE Profile APIs.io
Teachworks Credit Note Allocations API
AE Profile APIs.io
Teachworks Employees API
AE Profile APIs.io
Teachworks Invoices API
AE Profile APIs.io
Teachworks Lesson Participants API
AE Profile APIs.io
Teachworks Lessons API
AE Profile APIs.io
Teachworks Locations API
AE Profile APIs.io
Teachworks Other Compensation API
AE Profile APIs.io
Teachworks Other Events API
AE Profile APIs.io
Teachworks Payment Allocations API
AE Profile APIs.io
Teachworks Payments API
AE Profile APIs.io
#Customers
← Back to T APIs
API Details
ID
teachworks:teachworks-customers-api
Base URL
https://api.teachworks.com/v1
Docs
https://documenter.getpostman.com/view/10096149/SWTABydD
Provider
Teachworks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=teachworks-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/teachworks-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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