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

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

Thatch Employers API is one of 7 APIs that Thatch 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, an API reference, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version v1.

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

4 operations 2 paths 10 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://partners.thatchcloud.com/api/partners/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Thatch Employers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer). By default, every request must be authenticated.

  • Bearer — All requests are authenticated with your API key using Bearer token authentication. Include the header Authorization: Bearer . Generate an API key in the Thatc…

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.

POST
/employers
Create an employer
createEmployer body → 201401
GET
/employers
List employers
listEmployers 2 params → 200401
GET
/employers/{employer_id}
Get an employer
getEmployer 1 param → 200401404
PATCH
/employers/{employer_id}
Update an employer
updateEmployer 1 param body → 200401404

Schemas 10

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

Employer
object
17 properties
CurrentHealthInsurance
object
Current health insurance plan details
4 properties
EmployerCreate
object
19 properties 8 required
PaySchedule
object
11 properties
EmployerPricing
object
The monthly pricing for the employer. Must be greater than the expected commission.
1 property
Money
object
A monetary amount in minor units with an ISO 4217 currency code.
2 properties
EmployerUpdate
object
5 properties
LifecycleEvent
object
3 properties
Metadata
object
Set of key-value pairs that you can attach to an API resource for storing additional structured information. Individual keys can be unset by posting an empty s…
Pagination
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thatch-employers-api-openapi.yml Raw ↑

Other APIs Thatch publishes across the network.

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