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

# Get Holiday Groups

GET {{baseUrl}}/holiday-groups

Retrieve a paginated list of holiday groups for the tenant.

Reference: https://docs.a1.uk.astutepayroll.in/api-reference/holiday-group/get-holiday-groups

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `page` (integer, optional) — Page number to retrieve. Starts from 1.
- `limit` (integer, optional) — Maximum number of records to return per page.
- `sortColumn` (string, optional) — Field to sort results by.
- `sortOrder` (enum, optional) — Sort direction.
  - Allowed values: `asc`, `desc`
- `searchColumn` (string, optional) — Column to search on.
- `searchValue` (string, optional) — Value to search for in `searchColumn`.
- `enabled` (boolean, optional) — Filter by enabled status.
- `include` (string, optional) — Comma-separated list of field paths to include in each row (e.g. uuid,holidayGroupName).

### Headers

- `vnd.a1.tenant-id` (string, optional) — Tenant identifier for multi-tenant environments

## Response

### 200

Successful Response

- `rows` (list of HolidayGroupsGetResponsesContentApplicationJsonSchemaRowsItems, optional)
- `limit` (integer, optional)
- `totalCount` (integer, optional) — Total number of matching holiday groups.
- `currentPage` (integer, optional)
- `totalPages` (integer, optional)

## Types

### HolidayGroupsGetResponsesContentApplicationJsonSchemaRowsItems

- `uuid` (string, optional)
- `holidayGroupName` (string, optional)
- `enabled` (boolean, optional)
- `description` (string, optional, nullable)
- `externalId` (string, optional, nullable)
- `country` (string, optional, nullable)
- `region` (string, optional, nullable)
- `holidayCount` (string, optional) — Number of holidays in the group.
- `derivedHolidayGroupCount` (string, optional) — Number of holiday groups derived from this one.

## Examples

**Response**

```json
{
  "rows": [
    {
      "uuid": "0f98c866-a458-4db5-9950-0fb996042520",
      "holidayGroupName": "UK Public Holidays",
      "enabled": true,
      "description": "Bank holidays for England and Wales",
      "externalId": "string",
      "country": "string",
      "region": "string",
      "holidayCount": "8",
      "derivedHolidayGroupCount": "0"
    }
  ],
  "limit": 20,
  "totalCount": 110,
  "currentPage": 1,
  "totalPages": 6
}
```

**SDK Code**

```python
import requests

url = "https://{{baseurl}}/holiday-groups"

querystring = {"page":"1","limit":"20","sortColumn":"holidayGroupName","searchColumn":"holidayGroupName","searchValue":"UK"}

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://{{baseurl}}/holiday-groups?page=1&limit=20&sortColumn=holidayGroupName&searchColumn=holidayGroupName&searchValue=UK")! 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()
```