Getting Started

Pagination

All list endpoints support standard pagination, sorting, and filtering through query parameters.

Query Parameters

ParameterTypeDescription
pageintegerPage number to retrieve. Starts from 1.
limitintegerNumber of records per page.
sortColumnstringColumn used for sorting (e.g. lastName, firstName).
sortOrderstringSorting direction: asc or desc.
statusFilterstringFilter by status (e.g. 1 for active employees).
searchColstringColumn to search on. Used together with searchVal.
searchValstringValue to search for in the specified column.
payCycleIdstringFilter results to a specific pay cycle.

Example Request

$curl -X GET "https://<client>.pb.deel.com/employees/list?page=1&limit=20&sortColumn=lastName&sortOrder=asc&statusFilter=1" \
>  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>  -H "Accept: application/json"

Response Metadata

Every paginated response includes metadata to help you navigate through results:

FieldTypeDescription
totalCountintegerTotal number of matching records.
totalPagesintegerTotal number of pages available.
limitintegerPage size used for the request.
currentPageintegerCurrent page number returned.

Example Response

1{
2  "rows": [
3    {
4      "UUID": "e2ed0e36-de0f-445e-9340-68974de2664b",
5      "firstName": "John",
6      "lastName": "Doe",
7      "employeeStatus": "active"
8    }
9  ],
10  "totalCount": 1310,
11  "totalPages": 66,
12  "limit": 20,
13  "currentPage": 1
14}

To retrieve subsequent pages, increment the page parameter:

PageQuery
First 20 recordspage=1&limit=20
Records 21-40page=2&limit=20
Records 201-300page=3&limit=100

If page exceeds totalPages, an empty rows array is returned.