Skip to main content

Getting started with the Thera API

The Thera API gives you read-only access to your company's data in Thera, so your own tools can pull it in automatically.

What the Thera API is

The Thera API gives you read-only access to your company's data in Thera, so your own tools can pull it in automatically. You don't need to log in and export files by hand.

Common uses include:

  • Feeding contractor, payroll or time off data into an internal dashboard or BI tool

  • Syncing team and contract details with your HR or accounting system

  • Automating exports you currently download as CSV files

  • Reconciling payments and bank transactions with your own records

The API is read only. It can view your data but cannot create, change or delete anything in your Thera account.

What data you can access

The API covers three main areas: your company, your workers and your payroll. You'll only see data for the Thera products your company uses. For example, US payroll data appears only if you run US payroll with Thera.

The full API documentation lists every endpoint, with example requests and responses.

All available endpoints

Every endpoint below is a read-only GET request. Select an endpoint name to see its full request and response details in the API documentation.

Category

Endpoints

Company

Get Teams For Company, Get Org Chart, Get Managers, Get All Company Affiliations, Check Can Create Account, Get Contractor CSV, Get Contracts CSV, Generate Report, Download Signed Contracts, Get Company Tasks

Documents and API keys

Download US IRS 1099-NEC Archive, List API Keys

Accounting and integrations

Get Company Accounting Integrations Info, Get Company Accounting Mapping Details, Get Google Calendar Status

Bank and pay-ins

Get Plaid Bank Account Details, Get Payment Methods, Get Pay in History, Get Pay In Monthly Totals, Get Pay In Details, Get Payment By Type, Get Pay In Count

Bank transactions

Get All Accounts for a Given Company, Get all account Transactions, Get a detailed account transaction, List ACH transfers with filtering options, Get ACH transfer details by ID

Workers and contracts

Get US Contractors Tax Info API, Get Pay Cycle, List Scheduled Rate Changes

US payroll

Get Employee Scheduled Hours, Get Employee First Pay Configurations, Get Current Offcycle Checks, Get All Oncycle Checks, Get Oncycle Checks Details, Get US Pay Schedule, List US Pay Schedules, Get Some Pay Schedule Paydays

US expenses

Get US Expense, List US Expenses For Company, List US Expenses By Contract

Timesheets

Get Or Create Current Timesheet, Get Timesheet, List My Timesheets, List Timesheets, Get Timesheet History, Get Payroll Timesheet Review, List Carryover Eligible Timesheets

Time tracking

Get Company Time Tracking Settings, List Employee Time Tracking Settings, Get All Time Tracking, Get Time Tracking By Invoice, Get Time Tracking History, Get Time Tracking CSV

Time off

Calculate PTO Suggested Deduction, Get Time Off Policies By Company, Get Timeoff Policy, Get All Contractors' Time Off by Company, Get Time Off History By Contractor, Get Contractor Policies' Details By Policy, Get Contractor's Policies Details, Get Holiday Dates by User ID, Get Time Offs Csv, Get Accrual Ledger History, Get Balance Summary, Get Bulk Balance Summary, Get Bulk V1 Balance Summary

Disbursements

Get Invoices CSV

Who can create an API key

Only organization admins can create API keys. The API keys page in Settings is visible only to organization admins, so other users on your account won't see it.

If you need API access and you're not an admin, ask your organization admin to create a key and share it with you or your developer securely.

Each key belongs to one company and can only read that company's data.

How to create an API key

  1. Log in to Thera as an organization admin.

  2. Go to Settings, then open the API keys page. You can also go straight to /account-preferences/api-keys in the Thera app.

  3. Create a new API key.

  4. Copy the key and store it somewhere secure, such as a password manager or your system's secrets store.

How to use your key

Send your key in the X-Thera-API-Key header of every request. Here's an example that fetches your company's teams:

curl https://api.getthera.com/companies/{companyId}/teams \   -H "X-Thera-API-Key: <your key>"

A few things to know:

  • Company ID: Most requests need your companyId. If you can't find it, contact Thera support.

  • Rate limit: You can make up to 600 requests a minute. If you go over, you'll get a 429 error that tells you how long to wait before trying again.

  • Errors: Every error code and what it means is listed on the Errors page of the API documentation.

Keeping your key safe

Treat your API key like a password. Anyone who has it can read your company's data in Thera.

  • Store it in a password manager or secrets store, not in code, spreadsheets or shared documents.

  • Only share it with people who need it, and use a secure channel when you do.

  • Never send your full key by email or in a support ticket. If Thera support needs to identify a key, we'll only ask for the last 4 characters.

  • If you think a key has been exposed, contact Thera support right away.

Full API documentation and help

For every endpoint, with example requests and responses, see the Thera API documentation.

Questions about the API or your key? Contact Thera support and we'll help.

Did this answer your question?