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

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

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

This API exposes 4 operations across 2 paths, and defines 8 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 8 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 Employees 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.

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.

POST
/employees
Create an employee
createEmployee body → 201401
GET
/employees
List employees
listEmployees 3 params → 200401
GET
/employees/{id}
Get an employee
getEmployee 1 param → 200401404
PATCH
/employees/{id}
Update an employee
updateEmployee 1 param body → 200401404

Schemas 8

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

EmployeeCreate
object
16 properties 5 required
EmployeeUpdate
object
15 properties
Dependent
object
2 properties
EmployeePayScheduleRef
object
3 properties
EnrollmentEvent
object
6 properties
Employee
object
15 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-employees-api-openapi.yml Raw ↑

Other APIs Thatch publishes across the network.

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