List Users
Retrieve a list of Users.
By default, former employees are excluded from the response. In order to retrieve them, you may add the ?dtContractEnd=notequal,null query parameter to your request.
Query parameters
User's identifier.
Format: ({comparator},)?{date}.
Format: ({comparator},)?{date | 'null'}.
Only return users/employees who have been modified since {date}.
Format: '{comparator},{date-time}'
{offset},{limit}. Defaults to 0,1000.
Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with ?fields=extendedData.
User's mail (strict equality). You may prefix with the like, operator in order to execute a LIKE search (e.g.: ?mail=like,jdoe).
User's login (strict equality).
Whether former (terminated) employees should be included in response ?formerEmployees=true along active employees. They are excluded by default. Please note that you may not be able to retrieve former employees even when including them, depending on your access rights.
Response
OK
Example response
{
"data": {
"items": [
{
"id": 416,
"name": "John Doe",
"url": "http://example.ilucca.net/api/users/1",
"displayName": "Doe John",
"modifiedAt": "2015-09-07T10:20:06.583",
"lastName": "DOE",
"firstName": "John",
"login": "jdoe",
"mail": "no-reply@lucca.fr",
"dtContractStart": "2014-09-01T00:00:00",
"dtContractEnd": null,
"birthDate": "1989-12-22T00:00:00",
"employeeNumber": "00057",
"calendarId": 1,
"calendar": {
"id": 1,
"url": "http://example.ilucca.net/api/v3/publicHolidayCalendars/1",
"name": "Jours fériés en France"
},
"cultureID": 1036,
"culture": {
"id": 1036,
"name": "français (France)",
"url": "http://example.ilucca.net/api/v3/cultures/1036"
},
"picture": {
"id": "74d381db-dd4d-4f64-bc1e-582d806e58a8",
"url": "http://example.ilucca.net/api/v3/files/74d381db-dd4d-4f64-bc1e-582d806e58a8",
"name": "jdoe.png"
},
"legalEntityId": 1,
"legalEntity": {
"id": 1,
"name": "Lucca",
"url": "http://example.ilucca.net/api/v3/legalEntities/1"
},
"departmentId": 13,
"department": {
"id": 13,
"name": "BU Timmi/Lucca",
"url": "http://example.ilucca.net/api/v3/departments/13"
},
"managerId": 383,
"manager": {
"id": 383,
"name": "Roger Smith",
"url": "http://example.ilucca.net/api/v3/users/383"
},
"rolePrincipalId": 55,
"rolePrincipal": {
"id": 55,
"name": "User",
"url": "http://example.ilucca.net/api/v3/roles/55"
},
"habilitedRoles": [
{
"id": 59,
"name": "Employee +",
"url": "http://example.ilucca.net/api/v3/roles/59"
},
{
"id": 63,
"name": "Analytics access",
"url": "http://example.ilucca.net/api/roles/63"
}
],
"userWorkCycles": [
{
"id": 288,
"ownerID": 416,
"workCycleID": 6,
"startsOn": "1900-01-01T00:00:00",
"endsOn": "2015-03-09T00:00:00"
},
{
"id": 289,
"ownerID": 416,
"workCycleID": 9,
"startsOn": "2015-03-10T00:00:00",
"endsOn": "2015-10-13T00:00:00"
},
{
"id": 317,
"ownerID": 416,
"workCycleID": 14,
"startsOn": "2015-10-13T00:00:00",
"endsOn": "9999-12-31T00:00:00"
}
],
"allowsElectronicPayslip": true,
"userAxisValues_2": {
"id": 35
}
}
]
}
}