> ## Client identification
>
> Requests to this API should include a `Client-Platform` header alongside
> `Authorization`, identifying the application, tool, or model making the
> request. This is used for integration support and analytics.
>
> Use your model or tool name, for example `claude-code` or `chatgpt`.
>
> Example:
>
> ```bash
> curl https://api.salaryboxapp.com/... \
>   -H "Authorization: Api-Key <api-key>" \
>   -H "Client-Platform: claude-code"
> ```

# List Overtime Settings

GET https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime

Returns each staff member's overtime pay settings. Requires Payroll Pro. `config` is `null` when none exist; overtime is then paid at `0`.

- **Normal days:** overtime beyond `hourly_grace_period` is paid at `per_hour_amount` per hour.
- **Week offs and public holidays:** working the day is paid at `week_off_per_day_amount` or `public_holiday_per_day_amount` per day.
- Each amount type is `custom` (money) or `multipler` (a multiple of the staff member's hourly or daily salary, for example `2.00` for double pay).

For the day-by-day result, use Get Staff Overtime.


Reference: https://docs.salarybox.in/api-reference/payroll/config-overtime-retrieve

## Authentication

- `Authorization` header (required) (prefixed with ` Api-Key   `) — Format: "Api-Key \{api-key}"

## Request

### Query parameters

- `salarybox_ids` (list of string, optional) — Repeatable. Limits the result to these staff members, for example `salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP`.
- `page` (integer, optional) — Page number, starting at 1.
- `page_size` (integer, optional) — Results per page. Default and maximum 50.

## Response

### 200

One row per matching staff member on this page.

- `message` (string, required)
- `status` (boolean, required)
- `data` (list of EmployeeOvertimeConfig, required)
- `count` (integer, required) — Total number of matching staff members across all pages.
- `prev` (string, required, nullable) — URL of the previous page, or `null` on the first page.
- `next` (string, required, nullable) — URL of the next page, or `null` on the last page.

## Errors

### 403 Forbidden Error

Your plan does not include payroll.

- `message` (string, required)
- `status` (boolean, required)
- `errors` (map from string to any, optional, nullable)

### 404 Not Found Error

The requested page does not exist.

- `message` (string, required)
- `status` (boolean, required)
- `errors` (map from string to any, optional, nullable)

## Types

### EmployeeOvertimeConfig

- `salarybox_id` (string, required) — The staff member's SalaryBox ID.
- `employee_id` (string, required, nullable) — Your company's own employee ID for this person. `null` or an empty string when not set.
- `name` (string, required) — Full name from the staff profile.
- `branches` (list of string, required) — Names of the branches the person is assigned to. Deleted branches are left out.
- `departments` (list of string, required) — Names of the departments the person is in. Deleted departments are left out.
- `config` (OvertimeConfig, required, nullable) — The overtime settings payroll applies to this person, or `null` when none exist (overtime is counted but paid at 0).

### OvertimeConfig

A staff member's overtime pay settings. Amount types are spelled `multipler` exactly as shown. See the endpoint description for how payroll applies them.

- `per_hour_amount_type` (enum, required) — How `per_hour_amount` is read. `custom` is money per overtime hour; `multipler` is a multiple of the per-hour salary.
  - Allowed values: `custom`, `multipler`
- `per_hour_amount` (string, required) — Pay per payable overtime hour on normal days, as money or a multiplier, as a 2-decimal string.
- `hourly_grace_period` (string, required) — Grace period for hour-wise overtime as a duration, `HH:MM:SS`. A day's overtime hours are paid only if they are more than this; then all of them are paid. `"00:00:00"` means any overtime is paid.
- `week_off_per_day_amount_type` (enum, required) — How `week_off_per_day_amount` is read. `custom` is money per day; `multipler` is a multiple of the per-day salary.
  - Allowed values: `custom`, `multipler`
- `week_off_per_day_amount` (string, required) — Pay per overtime day for working on a week off, as money or a multiplier, as a 2-decimal string. For example `"1.50"` with `multipler` pays one and a half days' salary.
- `public_holiday_per_day_amount_type` (enum, required) — How `public_holiday_per_day_amount` is read. `custom` is money per day; `multipler` is a multiple of the per-day salary.
  - Allowed values: `custom`, `multipler`
- `public_holiday_per_day_amount` (string, required) — Pay per overtime day for working on a public holiday, as money or a multiplier, as a 2-decimal string.

## Examples

**Response**

```json
{
  "message": "Success",
  "status": true,
  "data": [
    {
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Bengaluru HQ"
      ],
      "departments": [
        "Sales"
      ],
      "config": {
        "per_hour_amount_type": "custom",
        "per_hour_amount": "150.00",
        "hourly_grace_period": "00:30:00",
        "week_off_per_day_amount_type": "multipler",
        "week_off_per_day_amount": "1.50",
        "public_holiday_per_day_amount_type": "multipler",
        "public_holiday_per_day_amount": "2.00"
      }
    },
    {
      "salarybox_id": "SBR4T8W2PL",
      "employee_id": "EMP-0063",
      "name": "Rohan Verma",
      "branches": [
        "Pune Plant"
      ],
      "departments": [],
      "config": null
    }
  ],
  "count": 2,
  "prev": null,
  "next": null
}
```

**SDK Code**

```python Example
import requests

url = "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime"

headers = {"Authorization": "Api-Key  <apiKey>"}

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

print(response.json())
```

```javascript Example
const url = 'https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime';
const options = {method: 'GET', headers: {Authorization: 'Api-Key  <apiKey>'}};

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

```go Example
package main

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

func main() {

	url := "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime"

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

	req.Header.Add("Authorization", "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 Example
require 'uri'
require 'net/http'

url = URI("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime")

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

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

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

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

HttpResponse<String> response = Unirest.get("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime")
  .header("Authorization", "Api-Key  <apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime', [
  'headers' => [
    'Authorization' => 'Api-Key  <apiKey>',
  ],
]);

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

```csharp Example
using RestSharp;

var client = new RestClient("https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Api-Key  <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Example
import Foundation

let headers = ["Authorization": "Api-Key  <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.salaryboxapp.com/v2/customer/v1/payroll/config/overtime")! 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()
```