List Employees
Retrieve a paginated list of employees with optional expansions for related data.
GET
/api/v1/employees?page=1Description
Retrieves all employees and their associated locations registered on your organization account. This endpoint supports pagination and optional email filtering.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | Number | No | Specifies the page number for pagination. Default is 1. |
| String | No | Filter employees by email address. Returns only matching employees. |
Response Fields
| Field | Type | Description |
|---|---|---|
| totalUsers | number | Total number of users in the result set |
| totalPages | number | Total number of available pages |
| currentPage | number | Current page number |
| users[] | array | List of employee records |
| users[].AssignedAssets | array | Assets assigned to a user (can be empty) |
| users[].FirstName | string | Employee first name |
| users[].LastName | string | Employee last name |
| users[].Email | string | Employee email address |
| users[].Address_1 | string | Primary address line |
| users[].City | string | City name |
| users[].State | string | State or region |
| users[].Zip | string | Postal or ZIP code |
Notes
- Default page size is up to 10 records per page.
- Use the optional email query parameter to filter results.
- Always send a valid bearer token in the Authorization header.
Related Endpoints
Did this page help you?
Request: Basic List
curl -X GET https://dev-api.unduit.com/api/v1/employees?page=1 \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Request: Filter by Email
curl -X GET https://dev-api.unduit.com/api/v1/employees?page=1&email=jane.smith%40example.com \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response (200)
{
"totalUsers": 465,
"totalPages": 47,
"currentPage": 1,
"users": [
{
"FirstName": "John",
"LastName": "Doe",
"LocationName": null,
"PhoneCountryCode": "US",
"ContactInfo": "1234567890",
"Email": "[email protected]",
"Country": "US",
"State": "CA",
"City": "Los Angeles",
"Zip": "90001",
"LocationType": "Remote Employee",
"Address_1": "1234 Elm Street",
"Address_2": "",
"AssignedAssets": []
},
{
"FirstName": "Jane",
"LastName": "Smith",
"LocationName": null,
"PhoneCountryCode": "US",
"ContactInfo": "0987654321",
"Email": "[email protected]",
"Country": "US",
"State": "NY",
"City": "New York",
"Zip": "10001",
"LocationType": "Remote Employee",
"Address_1": "5678 Oak Avenue",
"Address_2": "Unit 202",
"AssignedAssets": [
{
"assetId": "LEN-0000-ABCD1234",
"modelName": "Demo Laptop",
"modelNumber": "DL-1234",
"productType": "Laptop",
"purchaseDate": "2024-10-31",
"serialNumber": "SN-ABCD1234",
"imei": "",
"imei2": "",
"sku": "",
"assetStatus": "In Use"
}
]
}
]
}