> ## 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 Employment History

GET https://api.salaryboxapp.com/v2/customer/v1/staff/employment-history

Returns staff members' previous employers, as entered in the past employment section of their SalaryBox profile. This is their work history before your company.

Grouped by staff member: each item is one person followed by `employment_history`, newest `joining_date` first (entries with no `joining_date` come last). Only staff with at least one entry are listed.


Reference: https://docs.salarybox.in/api-reference/staff/employment-history-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 500.

## Response

### 200

- `message` (string, required)
- `status` (boolean, required)
- `data` (list of EmployeeEmploymentHistory, required)
- `count` (integer, required) — Total number of matching staff members (with at least one past-employment entry) 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.

## Types

### EmployeeEmploymentHistory

Identity fields shared by per-employee payroll responses.

- `employment_history` (list of EmploymentHistoryItem, required) — The staff member's previous jobs, newest `joining_date` first; entries with no `joining_date` come last. Never empty, because staff with no past employment are not listed.
- `salarybox_id` (string, optional) — SalaryBox ID of the staff member. Not null.
- `employee_id` (string, optional) — The employee ID your company assigned. Not null, may be empty.
- `name` (string, optional) — Full name of the staff member. Not null.
- `branches` (list of string, optional) — Names of the branches the staff member belongs to. Empty list if none.
- `departments` (list of string, optional) — Names of the departments the staff member belongs to. Empty list if none.

### EmploymentHistoryItem

One previous job of a staff member. The staff member is identified on the parent item, so there is no `salarybox_id` here.

- `company_name` (string, required) — Name of the previous employer, as entered. Can be an empty string.
- `designation` (string, required) — The person's job title at the previous employer. Empty string when not entered.
- `joining_date` (date, required, nullable) — Date the person started at the previous employer (`YYYY-MM-DD`). `null` when not entered.
- `leaving_date` (date, required, nullable) — Date the person left the previous employer (`YYYY-MM-DD`). `null` when not entered.
- `salary` (string, required, nullable) — Salary at the previous employer, as entered on the profile, as a string with exactly 2 decimals (for example `"32000.00"`). Read it together with `currency`. SalaryBox does not record whether the amount is monthly or yearly. `null` when not entered.
- `currency` (string, required) — Currency code of `salary`, for example `INR`, `USD` or `AED`. Empty string when not entered.
- `company_gst` (string, required) — GSTIN of the previous employer. When present it has passed a GSTIN format check. Empty string when not entered.

## Examples

**Response**

```json
{
  "message": "Success",
  "status": true,
  "data": [
    {
      "employment_history": [
        {
          "company_name": "Infosys Ltd",
          "designation": "HR Associate",
          "joining_date": "2019-07-01",
          "leaving_date": "2022-05-31",
          "salary": "32000.00",
          "currency": "INR",
          "company_gst": "29AABCI1681G1ZS"
        },
        {
          "company_name": "Sunrise Textiles",
          "designation": "Trainee",
          "joining_date": "2017-06-01",
          "leaving_date": "2019-06-15",
          "salary": null,
          "currency": "",
          "company_gst": ""
        }
      ],
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Mumbai HQ"
      ],
      "departments": [
        "Engineering"
      ]
    }
  ],
  "count": 1,
  "prev": null,
  "next": null
}
```

**SDK Code**

```python Example
import requests

url = "https://api.salaryboxapp.com/v2/customer/v1/staff/employment-history"

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/staff/employment-history';
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/staff/employment-history"

	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/staff/employment-history")

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/staff/employment-history")
  .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/staff/employment-history', [
  'headers' => [
    'Authorization' => 'Api-Key  <apiKey>',
  ],
]);

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

```csharp Example
using RestSharp;

var client = new RestClient("https://api.salaryboxapp.com/v2/customer/v1/staff/employment-history");
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/staff/employment-history")! 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()
```