> This page is for version API + Legacy Read.
> For other versions, use one of these documentation indexes:
> - API (default): https://docs.getthera.com/api/llms.txt
> - API + Legacy Read: https://docs.getthera.com/api-legacy-read/llms.txt
> - API + Legacy Full: https://docs.getthera.com/api-legacy-full/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getthera.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getthera.com/_mcp/server.

# List US Pay Schedules

GET https://api.getthera.com/companies/{companyId}/w2-payroll/pay-schedules



Reference: https://docs.getthera.com/thera-api/payroll/payschedule-api/list-w-2-pay-schedules

## Authentication

- `X-Thera-API-Key` header (required) — API Key authentication via header

## Servers

- `https://api.getthera.com` (Production, default)
- `https://api.staging.getthera.com` (Staging)

## Request

### Path parameters

- `companyId` (string, required)

## Response

### 200

- `list of GetPayScheduleResponse`

## Types

### GetPayScheduleResponse

- `id` (string, required)
- `company` (string, required)
- `name` (string, required)
- `payFrequency` (enum, required)
  - Allowed values: `weekly`, `biweekly`, `semimonthly`, `monthly`, `quarterly`, `annually`
- `firstPayDate` (date, required)
- `firstPeriodEndDate` (date, required)
- `isEditable` (boolean, required) — Whether the cycle's *shape* can still change: pay frequency, first payday, second payday and first period end. Once any payroll exists against the cycle, updates to those are ignored. Name, metadata and scheduled hours stay editable either way, so this must not be read as "the cycle cannot be edited".
- `metadata` (any, required)
- `secondPayDate` (date, optional)
- `scheduledHoursPerWeek` (double, optional) — Weekly hours seeded onto hourly employees' regular earning lines on this cycle. Unset means the standard full-time week; zero means seed no hours so the employer enters them.

## Examples

**Response**

```json
[
  {
    "id": "id",
    "company": "company",
    "name": "name",
    "payFrequency": "weekly",
    "firstPayDate": "2023-01-15",
    "firstPeriodEndDate": "2023-01-15",
    "isEditable": true,
    "metadata": {
      "key": "value"
    },
    "secondPayDate": "2023-01-15",
    "scheduledHoursPerWeek": 1.1
  },
  {
    "id": "id",
    "company": "company",
    "name": "name",
    "payFrequency": "weekly",
    "firstPayDate": "2023-01-15",
    "firstPeriodEndDate": "2023-01-15",
    "isEditable": true,
    "metadata": {
      "key": "value"
    },
    "secondPayDate": "2023-01-15",
    "scheduledHoursPerWeek": 1.1
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules"

headers = {"X-Thera-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules';
const options = {method: 'GET', headers: {'X-Thera-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Thera-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Thera-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules")
  .header("X-Thera-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules', [
  'headers' => [
    'X-Thera-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Thera-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Thera-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getthera.com/companies/companyId/w2-payroll/pay-schedules")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```