> 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 employees

GET {{baseUrl}}/employees/list

Retrieves a paginated list of employees.

Reference: https://docs.a1.uk.astutepayroll.in/api-reference/employee/get-employees

## 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, default: 1) — Page number, starting from 1.
- `limit` (integer, optional, default: 10) — Page size. Defaults to 10; values above 500 are capped at 500.
- `searchCol` (enum, optional) — Column to search, used with `searchVal`.
  - Allowed values: `firstName`, `lastName`, `email`
- `searchVal` (string, optional) — Text to look for in `searchCol` (partial, case-insensitive match).
- `sortColumn` (string, optional) — Column to sort by.
- `sortOrder` (enum, optional, default: asc)
  - Allowed values: `asc`, `desc`
- `payCycleId` (string, optional) — Only employees on this pay cycle.
- `statusFilter` (enum, optional) — `1` active, `2` inactive, `3` terminated. Omit it to return all employees.
  - Allowed values: `1`, `2`, `3`

## Response

### 200

Successful Response

- `rows` (list of EmployeesListGetResponsesContentApplicationJsonSchemaRowsItems, optional)
- `limit` (double, optional) — Page size
- `totalCount` (double, optional) — Number of employees matching the filters
- `currentPage` (double, optional) — Current page number
- `totalPages` (double, optional) — Number of pages

## Types

### EmployeesListGetResponsesContentApplicationJsonSchemaRowsItems

- `UUID` (string, optional) — Employee UUID
- `name` (string, optional) — Full name in `lastName,firstName` format
- `nameKnowAs` (string, optional) — Preferred or known-as name
- `firstName` (string, optional) — First name
- `middleName` (string, optional) — Middle name
- `lastName` (string, optional) — Last name
- `type` (string, optional) — Employment type, `PAYE` or `Subcontractor`
- `primaryemail` (string, optional) — Primary email address
- `activeJobs` (double, optional) — Number of active jobs
- `inactiveJobs` (double, optional) — Number of inactive jobs
- `futureJobs` (double, optional) — Number of future jobs
- `sortColumn` (string, optional) — Column used for sorting
- `employeeStatus` (enum, optional) — Employee status
  - Allowed values: `active`, `inactive`, `Terminated`
- `employeeNo` (double, optional) — Employee number
- `userID` (string, optional) — User ID of the employee
- `lastSyncStatus` (EmployeesListGetResponsesContentApplicationJsonSchemaRowsItemsLastSyncStatus, optional) — Sync status per category (`JOB`, `TAX`, `BANK`, `EMPLOYEE`, `PERSONAL`, `ENGAGEMENT`), each with `message` and `success`, plus `updatedAt`
- `engagementUuid` (string, optional) — UUID of the engagement
- `id` (integer, optional) — Internal employee ID
- `userUuid` (string, optional) — User id of the employee (not a UUID), used by Get Employee and the update endpoints
- `externalEmployeeNumber` (string, optional, nullable) — External employee number from an integration
- `externalId` (string, optional, nullable) — External ID
- `payType` (string, optional) — Pay type, `PAYE` or `Subcontractor`
- `regionCode` (string, optional) — Region code
- `createdAt` (datetime, optional) — When the employee was created
- `isLocked` (boolean, optional) — Whether the user account is locked

### EmployeesListGetResponsesContentApplicationJsonSchemaRowsItemsLastSyncStatus

Sync status per category (`JOB`, `TAX`, `BANK`, `EMPLOYEE`, `PERSONAL`, `ENGAGEMENT`), each with `message` and `success`, plus `updatedAt`

## Examples

**Response**

```json
{
  "rows": [
    {
      "UUID": "c203dbf2-0098-4e8b-a424-c72fe85da8be",
      "name": "Smith,Jane",
      "nameKnowAs": "",
      "firstName": "Jane",
      "middleName": "",
      "lastName": "Smith",
      "type": "PAYE",
      "primaryemail": "jane.smith@example.com",
      "activeJobs": 1,
      "inactiveJobs": 0,
      "futureJobs": 0,
      "sortColumn": "lastName",
      "employeeStatus": "active",
      "employeeNo": 0,
      "userID": "axx3KG7hLaQxiAQtHgp3x34m",
      "lastSyncStatus": {},
      "engagementUuid": "c784c0bb-5a5e-4900-83e8-ca04b2b9c13f",
      "id": 30561,
      "userUuid": "axx3KG7hLaQxiAQtHgp3x34m",
      "externalEmployeeNumber": null,
      "externalId": null,
      "payType": "PAYE",
      "regionCode": "GB",
      "createdAt": "2026-08-27T07:43:29.701Z",
      "isLocked": false
    }
  ],
  "limit": 10,
  "totalCount": 1,
  "currentPage": 1,
  "totalPages": 1
}
```

**SDK Code**

```python Employee_getEmployees_example
import requests

url = "https://{{baseurl}}/employees/list"

querystring = {"page":"1","limit":"20","searchCol":"lastName","searchVal":"smith","sortColumn":"lastName","sortOrder":"asc","payCycleId":"e2daeed0-2803-4931-b71e-a63a21a26378","statusFilter":"1"}

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

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

print(response.json())
```

```javascript Employee_getEmployees_example
const url = 'https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1';
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 Employee_getEmployees_example
package main

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

func main() {

	url := "https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1"

	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 Employee_getEmployees_example
require 'uri'
require 'net/http'

url = URI("https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1")

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 Employee_getEmployees_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Employee_getEmployees_example
using RestSharp;

var client = new RestClient("https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Employee_getEmployees_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://{{baseurl}}/employees/list?page=1&limit=20&searchCol=lastName&searchVal=smith&sortColumn=lastName&sortOrder=asc&payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378&statusFilter=1")! 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()
```