Thatch Health

Thatch Health Pay Schedules API

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

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 5

POST /employers/{employer_id}/pay_schedules Create a pay schedule #
GET /employers/{employer_id}/pay_schedules List pay schedules for an employer #
GET /employers/{employer_id}/pay_schedules/{pay_schedule_id} Get a specific pay schedule #
PATCH /employers/{employer_id}/pay_schedules/{pay_schedule_id} Update a pay schedule #
DELETE /employers/{employer_id}/pay_schedules/{pay_schedule_id} Deactivate a pay schedule #

Documentation

📖
Documentation
https://docs.thatch.com/
📖
APIReference
https://docs.thatch.com/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/thatch-health/refs/heads/main/openapi/thatch-health-pay-schedules-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/thatch-health-pay-schedules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thatch-health-pay-schedules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Thatch for Platforms Pay Schedules API
  version: v1
  description: Thatch for Platforms is a set of REST APIs and embeddable JavaScript components that let partners bring ICHRA (Individual Coverage Health Reimbursement Arrangement) benefits to their customers.
  contact:
    name: Thatch for Platforms
    email: platforms@thatch.com
    url: https://docs.thatch.com/
  x-apisjson-generated: '2026-07-21'
  x-apisjson-method: generated
  x-apisjson-source: https://docs.thatch.com/api/
servers:
- url: https://partners.thatchcloud.com/api/partners/v1
  description: Production
security:
- Bearer: []
tags:
- name: Pay Schedules
  description: Pay schedules model the cadence of employee paychecks for the purpose of deduction calculations.
paths:
  /employers/{employer_id}/pay_schedules:
    parameters:
    - name: employer_id
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Pay Schedules
      operationId: createPaySchedule
      summary: Create a pay schedule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayScheduleCreate'
      responses:
        '201':
          description: Create a pay schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaySchedule'
        '401':
          $ref: '#/components/responses/Unauthorized'
    get:
      tags:
      - Pay Schedules
      operationId: listPaySchedules
      summary: List pay schedules for an employer
      parameters:
      - name: include_deactivated
        in: query
        description: Include deactivated pay schedules
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: List pay schedules for an employer
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PaySchedule'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /employers/{employer_id}/pay_schedules/{pay_schedule_id}:
    parameters:
    - name: employer_id
      in: path
      required: true
      schema:
        type: string
    - name: pay_schedule_id
      in: path
      required: true
      description: Pay schedule ID
      schema:
        type: string
    get:
      tags:
      - Pay Schedules
      operationId: getPaySchedule
      summary: Get a specific pay schedule
      responses:
        '200':
          description: Get a specific pay schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaySchedule'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Pay Schedules
      operationId: updatePaySchedule
      summary: Update a pay schedule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PayScheduleUpdate'
      responses:
        '200':
          description: Update a pay schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaySchedule'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Pay Schedules
      operationId: deactivatePaySchedule
      summary: Deactivate a pay schedule
      responses:
        '204':
          description: Successfully deactivated pay schedule
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    PaySchedule:
      type: object
      properties:
        id:
          type: string
          example: paysch_1234
        name:
          type: string
          example: Bi-Weekly Payroll
        reference_pay_date:
          type: string
          format: date
          deprecated: true
        start_date:
          type: string
          format: date
        end_date:
          type: string
          format: date
        frequency:
          type: string
          example: bi_weekly
        first_day:
          type: integer
          deprecated: true
        second_day:
          type: integer
          deprecated: true
        bank_closure_strategy:
          type: string
          example: before
        remote_id:
          type: string
          example: remote_123
        active:
          type: boolean
    PayScheduleCreate:
      type: object
      required:
      - bank_closure_strategy
      - frequency
      - name
      properties:
        bank_closure_strategy:
          type: string
          enum:
          - before
          - after
          - closest
          - ignore
          description: Strategy for handling bank closures
        frequency:
          type: string
          enum:
          - monthly
          - semi_monthly
          - bi_weekly
          - weekly
          description: Pay frequency
        name:
          type: string
          description: Readable name for the pay schedule
        first_pay_date:
          type: string
          format: date
          description: First pay date of the schedule
        second_pay_date:
          type: string
          format: date
          description: Second pay date of the schedule (only required for semi-monthly schedules)
        start_date:
          type: string
          description: Start date for the pay schedule (defaults to employer's earliest coverage start date on creation)
        end_date:
          type: string
          description: End date for the pay schedule
        reference_pay_date:
          type: string
          format: date
          deprecated: true
          description: Deprecated - use first_pay_date instead
        first_day:
          type: integer
          format: int32
          minimum: 1
          maximum: 31
          deprecated: true
          description: Deprecated - use first_pay_date instead
        second_day:
          type: integer
          format: int32
          minimum: 1
          maximum: 31
          deprecated: true
          description: Deprecated - use second_pay_date instead
    PayScheduleUpdate:
      type: object
      properties:
        name:
          type: string
        frequency:
          type: string
          enum:
          - monthly
          - semi_monthly
          - bi_weekly
          - weekly
        bank_closure_strategy:
          type: string
          enum:
          - before
          - after
          - closest
          - ignore
        first_pay_date:
          type: string
          format: date
        second_pay_date:
          type: string
          format: date
        start_date:
          type: string
        end_date:
          type: string
        reference_pay_date:
          type: string
          format: date
          deprecated: true
        first_day:
          type: integer
          format: int32
          minimum: 1
          maximum: 31
          deprecated: true
        second_day:
          type: integer
          format: int32
          minimum: 1
          maximum: 31
          deprecated: true
  responses:
    Unauthorized:
      description: Authentication failed or API key missing/invalid.
    NotFound:
      description: The requested resource was not found.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: 'All requests are authenticated with your API key using Bearer token authentication. Include the header `Authorization: Bearer <YOUR_API_KEY>`. Generate an API key in the Thatch dashboard.'