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

Thatch Health Employers API

Platforms onboard employers into Thatch, and have employeesenrolled in plans.

Thatch Health Employers API is one of 7 APIs that Thatch Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1.

Requests are made against a single base URL, //partners.thatchcloud.com/api/partners/v1/.

4 operations 2 paths 9 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
Base URL
https://partners.thatchcloud.com/api/partners/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Thatch Health Employers API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Provide your API key in a Bearer token header (as in, Bearer sk123).

Paths & Operations 4

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

Employers 4

Platforms onboard employers into Thatch, and have employees enrolled in plans.

GET
/employers
List employers
getEmployers 2 params → 200
POST
/employers
Create an employer
postEmployers body → 201
GET
/employers/{employer_id}
Get an employer
getEmployersEmployerId 1 param → 200
PATCH
/employers/{employer_id}
Update an employer
patchEmployersEmployerId 1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are postEmployers (19 properties), Employer (17 properties), PaySchedule (11 properties), Pagination (5 properties). Each schema is shown below with its type and property counts.

Employer
object
Employer model
17 properties 11 required
PaginatedEmployerList
object
PaginatedEmployerList model
2 properties
PaySchedule
object
PaySchedule model
11 properties 6 required
patchEmployersEmployerId
object
Update an employer
5 properties
postEmployers
object
Create an employer
19 properties 8 required
Money
object
2 properties 2 required
Pricing
object
1 property
EmployerLifecycleEvent
object
3 properties 3 required
Pagination
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thatch-health-employers-api-openapi.yml Raw ↑

Other APIs Thatch Health publishes across the network.

Thatch Health Deductions API
Thatch Health Employees API
Thatch Health Employer onboarding sessions API
Thatch Health Enrollments API
Thatch Health Members API
Thatch Health Pay Schedules API