Employees Directory
List Users
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
- Employees Directory
- Guides
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
Timmi Absences API
- Leaves
- Leave-requests
- Sick-leaves
- Imports
- Guides
Timmi Office API
- User-locations
- Work-locations
Timmi Project API
- Clients
- Projects
- Project services
- Organizations
- Financials
Timmi Settings API
- UserDates
- Workcycle-exceptions
- Working-time-arrangement
Timmi Timesheet API
- Time-entries
- Timesheets
- Reports
- Guides
Pagga Mealvouchers API
- Statutory
- Computation
Pagga Remuneration API
- Fixed-natures
- Fixed-items
- Variable-natures
- Variable-items
Poplee Training API
- Training-demands
- Realized-trainings
Employees Directory
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.
GET
/
api
/
v3
/
users
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/users \
--header 'Content-Type: application/json' \
--data '{}'
{
"items": [
{
"id": 123,
"name": "<string>",
"url": "<string>",
"displayName": "<string>",
"modifiedOn": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"login": "<string>",
"mail": "<string>",
"dtContractStart": "<string>",
"dtContractEnd": null,
"birthDate": "<string>",
"employeeNumber": "<string>",
"calendar": {
"id": 123,
"url": "<string>",
"name": "<string>"
},
"culture": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"picture": {
"id": "<string>",
"href": "<string>"
},
"applicationData": {},
"legalEntity": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"department": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"manager": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"rolePrincipal": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"habilitedRoles": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"userWorkCycles": [
{
"Id": 123,
"OwnerID": 123,
"WorkCycleID": 123,
"StartsOn": "<string>",
"EndsOn": "<string>"
}
]
}
]
}
Query Parameters
{comparator},{date-time}
.
{comparator},{date-time}
User's identifier
{comparator},{date-time}
{offset},{limit}. Defaults to 0,1000.
User's mail
User's login
Body
application/json · object
The body is of type object
.
Response
200
application/json
OK
Was this page helpful?
curl --request GET \
--url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/api/v3/users \
--header 'Content-Type: application/json' \
--data '{}'
{
"items": [
{
"id": 123,
"name": "<string>",
"url": "<string>",
"displayName": "<string>",
"modifiedOn": "<string>",
"lastName": "<string>",
"firstName": "<string>",
"login": "<string>",
"mail": "<string>",
"dtContractStart": "<string>",
"dtContractEnd": null,
"birthDate": "<string>",
"employeeNumber": "<string>",
"calendar": {
"id": 123,
"url": "<string>",
"name": "<string>"
},
"culture": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"picture": {
"id": "<string>",
"href": "<string>"
},
"applicationData": {},
"legalEntity": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"department": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"manager": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"rolePrincipal": {
"id": 123,
"name": "<string>",
"url": "<string>"
},
"habilitedRoles": [
{
"id": 123,
"name": "<string>",
"url": "<string>"
}
],
"userWorkCycles": [
{
"Id": 123,
"OwnerID": 123,
"WorkCycleID": 123,
"StartsOn": "<string>",
"EndsOn": "<string>"
}
]
}
]
}