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 Pay Schedules API

Pay schedules model the cadence of employee paychecks for the purpose of deduction calculations.

Thatch Health Pay Schedules 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 Pay Schedules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

5 operations 2 paths 3 schemas 1 DELETE2 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 Pay Schedules 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 5

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

Pay Schedules 5

Pay schedules model the cadence of employee paychecks for the purpose of deduction calculations.

GET
/employers/{employer_id}/pay_schedules
List pay schedules
getEmployersEmployerIdPaySchedules 2 params → 200
POST
/employers/{employer_id}/pay_schedules
Create a pay schedule
postEmployersEmployerIdPaySchedules 1 param body → 201
GET
/employers/{employer_id}/pay_schedules/{pay_schedule_id}
Get a pay schedule
getEmployersEmployerIdPaySchedulesPayScheduleId 2 params → 200
DELETE
/employers/{employer_id}/pay_schedules/{pay_schedule_id}
Deactivate a pay schedule
deleteEmployersEmployerIdPaySchedulesPayScheduleId 2 params → 204
PATCH
/employers/{employer_id}/pay_schedules/{pay_schedule_id}
Update a pay schedule
patchEmployersEmployerIdPaySchedulesPayScheduleId 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PaySchedule (11 properties), patchEmployersEmployerIdPaySchedulesPayScheduleId (10 properties), postEmployersEmployerIdPaySchedules (10 properties). Each schema is shown below with its type and property counts.

postEmployersEmployerIdPaySchedules
object
Create a pay schedule
10 properties 3 required
patchEmployersEmployerIdPaySchedulesPayScheduleId
object
Update a pay schedule
10 properties
PaySchedule
object
PaySchedule model
11 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thatch-health-pay-schedules-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 Employers API
Thatch Health Enrollments API
Thatch Health Members API