---
title: "List all taxwithholdings"
url: "https://docs.unified.to/hris/taxwithholding/List_all_taxwithholdings"
description: "List all taxwithholdings with Unified's Taxwithholding API (GET /hris/{connection_id}/taxwithholding). Filter by limit, offset and updated_gte. Supported by 5 Taxwithholding integrations."
date: "2026-11-16T23:13:16.218Z"
updated: "2026-11-16T23:13:16.218Z"
---
# List all taxwithholdings

Updated: November 16, 2026

 GET/hris/{connection\_id}/taxwithholding

Returns a list of HrisTaxwithholdings. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

## Parameters

**limit**number  default=100

**offset**number  default=0

**updated\_gte**date-time 

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**sort** enum

name

updated\_at

created\_at

**order** enum

asc

desc

**query**string 

Query string to search. eg. email address or name

**user\_id**string 

The user/employee ID to filter by (reference to HrisEmployee)

**company\_id**string 

The company ID to filter by (reference to HrisCompany)

**fields**string array 

id

created\_at

updated\_at

user\_id

company\_id

country

jurisdiction\_type

jurisdiction

is\_resident

form

filing\_status

tax\_code

allowances

claim\_amount

has\_multiple\_jobs

dependents\_amount

other\_income\_amount

other\_deductions\_amount

extra\_withholding\_amount

extra\_withholding\_percent

override\_type

override\_amount

is\_exempt

effective\_at

metadata

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

## Returns

[HrisTaxwithholding](https://docs.unified.to/hris/taxwithholding/model.md)array

Employee tax withholding settings for one jurisdiction (eg. W-4)

**id**string 

**created\_at**date-time 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date-time 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**user\_id**string 

employee ID (reference to HrisEmployee)

**company\_id**string 

(reference to HrisCompany)

**country**string 

ISO 3166-1 alpha-2 country code of the taxing authority (eg. US, CA)

**jurisdiction\_type** enum

Valid values:

 "FEDERAL" 

 "STATE" 

 "LOCAL" 

**jurisdiction**string 

region/locality code within the country (eg. CA, NY, NY-NYC); empty for FEDERAL

**is\_resident**boolean 

true for the resident (home) jurisdiction, false for a work-only jurisdiction

**form** enum

Valid values:

 "W4\_2020" 

 "W4\_LEGACY" 

 "STATE\_FORM" 

 "TD1" 

 "OTHER" 

withholding form the values come from (eg. 2020+ W-4)

**filing\_status** enum

Valid values:

 "SINGLE" 

 "MARRIED\_JOINTLY" 

 "MARRIED\_SEPARATELY" 

 "HEAD\_OF\_HOUSEHOLD" 

 "QUALIFYING\_SURVIVOR" 

 "OTHER" 

**tax\_code**string 

jurisdiction-specific tax code (eg. UK 1257L)

**allowances**number 

withholding allowances (pre-2020 W-4 and most state forms)

**claim\_amount**number 

dollar exemption / claim amount (eg. Canada TD1, Illinois IL-W-4)

**has\_multiple\_jobs**boolean 

W-4 step 2: multiple jobs or spouse works

**dependents\_amount**number 

W-4 step 3: dependents credit amount

**other\_income\_amount**number 

W-4 step 4a: other income amount

**other\_deductions\_amount**number 

W-4 step 4b: deductions amount

**extra\_withholding\_amount**number 

W-4 step 4c: additional amount withheld each pay period

**extra\_withholding\_percent**number 

additional percentage of wages withheld each pay period

**override\_type** enum

Valid values:

 "NONE" 

 "FIXED\_AMOUNT" 

 "PERCENT" 

replaces the calculated withholding with a flat amount or percentage

**override\_amount**number 

money (FIXED\_AMOUNT) or percentage (PERCENT) withheld instead of the calculated amount

**is\_exempt**boolean 

employee claims exemption from withholding in this jurisdiction

**effective\_at**date-time 

date these withholding settings take effect (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**metadata** array 

**raw** 

## Errors

 Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). 

```json
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
```

| Status | Error                 | Meaning                                           |
| ------ | --------------------- | ------------------------------------------------- |
| 400    | Bad Request           | The request was malformed or failed validation.   |
| 401    | Unauthorized          | The connection is likely broken; re-authorize it. |
| 403    | Forbidden             | The connection is missing permissions or scopes.  |
| 404    | Not Found             | The requested resource does not exist.            |
| 429    | Too Many Requests     | Rate limit exceeded (see the two sources below).  |
| 500    | Internal Server Error | An unexpected error occurred.                     |
| 501    | Not Implemented       | Not supported by this integration.                |

 Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. 

### 429 Too Many Requests

A 429 has two possible sources:

* The integration's own rate limit, passed through.
* Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`.

## Code Samples

### Node.js SDK

```javascript
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const results = await sdk.hris.listHrisTaxwithholdings({ connectionId, 
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    user_id: '',
    company_id: '',
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'GET',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    user_id: '',
    company_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

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

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

### Python

```python
import requests

url = "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

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

url = URI("https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw=")

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

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

### cURL

```bash
curl --request GET \
  --url 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxwithholding?limit=50&offset=0&updated_gte=2026-01-01T00:00:00.000Z&sort=updated_at&order=asc&query=&user_id=&company_id=&fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
