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 Employees API

Employees work for employers, both of which are managedby partners. Employees enrolled in plans are also represented in Thatch as member objects.

Thatch Health Employees 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 Employees. 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 8 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 8 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 Employees 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.

Employees 4

Employees work for employers, both of which are managed by partners. Employees enrolled in plans are also represented in Thatch as member objects.

GET
/employees
List employees
getEmployees 3 params → 200
POST
/employees
Create an employee
postEmployees body → 201
GET
/employees/{id}
Get an employee
getEmployeesId 1 param → 200
PATCH
/employees/{id}
Update an employee
patchEmployeesId 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are postEmployees (16 properties), patchEmployeesId (15 properties), Employee (15 properties), EnrollmentEvent (6 properties). Each schema is shown below with its type and property counts.

EmployeePaySchedule
object
3 properties 2 required
patchEmployeesId
object
Update an employee
15 properties
Dependent
object
2 properties 2 required
EnrollmentEvent
object
6 properties 5 required
postEmployees
object
Create an employee
16 properties 5 required
PaginatedEmployeeList
object
PaginatedEmployeeList model
2 properties
Employee
object
Employee model
15 properties 7 required
Pagination
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Thatch Health publishes across the network.

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