Get employees | Deel. PayAndBill API Documentation

curl -G https://{{baseurl}}/employees/list \
     -H "Authorization: Bearer <token>" \
     -d page=1 \
     -d limit=20 \
     -d searchCol=lastName \
     -d searchVal=smith \
     -d sortColumn=lastName \
     -d sortOrder=asc \
     -d payCycleId=e2daeed0-2803-4931-b71e-a63a21a26378 \
     -d statusFilter=1

{
  "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
}

Retrieves a paginated list of employees.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1Defaults to 1

Page number, starting from 1.

limitintegerOptional1-500Defaults to 10

Page size. Defaults to 10; values above 500 are capped at 500.

searchColenumOptional

Column to search, used with searchVal.

Allowed values:

searchValstringOptional

Text to look for in searchCol (partial, case-insensitive match).

sortColumnstringOptional

Column to sort by.

sortOrderenumOptionalDefaults to asc

Allowed values:

payCycleIdstringOptionalformat: "uuid"

Only employees on this pay cycle.

statusFilterenumOptional

1 active, 2 inactive, 3 terminated. Omit it to return all employees.

Allowed values:

Response

Successful Response

rowslist of objectsOptional

limitdoubleOptional

Page size

totalCountdoubleOptional

Number of employees matching the filters

currentPagedoubleOptional

Current page number

totalPagesdoubleOptional

Number of pages