> ## 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 a specific model identifier if you know it; otherwise use the name
> of the agent or product issuing the request.
>
> Examples:
>
> | Client | Value |
> |---|---|
> | GPT-5.6 Sol | `Client-Platform: gpt-5.6-sol` |
> | GPT-5.6 Luna | `Client-Platform: gpt-5.6-luna` |
> | GPT-5.6 Pro | `Client-Platform: gpt-5.6-pro` |
> | Claude Opus 4.6 | `Client-Platform: claude-opus-4.6` |
> | Claude Sonnet 4.6 | `Client-Platform: claude-sonnet-4.6` |
> | Gemini 3.1 Pro | `Client-Platform: gemini-3.1-pro` |
> | ChatGPT | `Client-Platform: chatgpt` |
> | Claude Code | `Client-Platform: claude-code` |
> | Codex | `Client-Platform: codex` |
> | Other | `Client-Platform: <your-tool-or-model-name>` |
>
> Example:
>
> ```bash
> curl https://api.salaryboxapp.com/... \
>   -H "Authorization: Api-Key <api-key>" \
>   -H "Client-Platform: claude-code"
> ```

# List Staff

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

Returns employee master data for the authenticated company.

Reference: https://docs.salarybox.in/api-reference/staff/retrieve

## Authentication

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

## Request

### Query parameters

- `salarybox_id` (string, optional) — Filter by SalaryBox ID.
- `employee_id` (string, optional) — Filter by employee ID.
- `name` (string, optional) — Search by employee name.
- `branches` (string, optional) — Comma-separated branch IDs to filter by.
- `departments` (string, optional) — Comma-separated department IDs to filter by.
- `job_title` (string, optional) — Filter by job title.
- `phone_number` (string, optional) — Filter by phone number.
- `page` (integer, optional) — Page number to fetch. Defaults to 1.
- `page_size` (integer, optional) — Number of results per page (max 500). Defaults to 25.

## Response

### 200

- `data` (list of Employee, required)
- `message` (string, required)
- `status` (boolean, required)
- `count` (integer, required)
- `prev` (string, required, nullable)
- `next` (string, required, nullable)

## Types

### Employee

- `salarybox_id` (string, required)
- `employee_id` (string, required)
- `name` (string, required)
- `branches` (list of any, required)
- `departments` (list of any, required)
- `job_title` (string, required)
- `phone_number` (string, required)
- `dial_code` (string, required)
- `joining_date` (string, required)
- `date_of_birth` (string, required)
- `pan` (string, required)
- `uan` (string, required)
- `aadhaar` (string, required)
- `driving_license` (string, required)
- `voter_id` (string, required)
- `email` (string, required)
- `current_address` (string, required)
- `permanent_address` (string, required, nullable)
- `employee_type` (string, required)
- `gender` (string, required)
- `marital_status` (string, required)
- `blood_group` (string, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "salarybox_id": "SBHYBSEEIG",
      "employee_id": "EMP001",
      "name": "apk test",
      "branches": [
        "New Apk Testing"
      ],
      "departments": [
        "Finance",
        "HR",
        "IT"
      ],
      "job_title": "Software Engineer",
      "phone_number": "9267909098",
      "dial_code": "91",
      "joining_date": "2020-01-01",
      "date_of_birth": "1990-01-01",
      "pan": "ABCDE0000F",
      "uan": "100987654321",
      "aadhaar": "123456789012",
      "driving_license": "DL0420110149646",
      "voter_id": "A123456789012",
      "email": "apk.test@example.com",
      "current_address": "123 Main St, City, State 12345",
      "permanent_address": "456 Oak Ave, City, State 12345",
      "employee_type": "Full-time",
      "gender": "Male",
      "marital_status": "Single",
      "blood_group": "O+"
    },
    {
      "salarybox_id": "SBXDFJHVMA",
      "employee_id": "EMP002",
      "name": "new test",
      "branches": [
        "B2"
      ],
      "departments": [
        "IT"
      ],
      "job_title": "Senior Software Engineer",
      "phone_number": "9995551112",
      "dial_code": "91",
      "joining_date": "2020-01-01",
      "date_of_birth": "1990-01-01",
      "pan": "ABCDE0000F",
      "uan": "100987654322",
      "aadhaar": "123456789012",
      "driving_license": "KA0520230001234",
      "voter_id": "A123456789012",
      "email": "new.test@example.com",
      "current_address": "789 Pine Rd, City, State 12345",
      "permanent_address": "012 Elm St, City, State 12345",
      "employee_type": "Full-time",
      "gender": "Male",
      "marital_status": "Single",
      "blood_group": "O+"
    }
  ],
  "message": "Success",
  "status": true,
  "count": 2,
  "prev": null,
  "next": null
}
```

**SDK Code**

```python Example
import requests

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

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

	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/")

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

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

```csharp Example
using RestSharp;

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