Employees Directory
Get a User by Id
Documentation
Organization Structure API
- Axis-sections
- Departments
- Legal-Units
- Establishments
Core HR API
Cleemy Expenses API
- Expense-temp-items
- Expense-claims
- Expense-claim-items
- Exports
- Guides
Cleemy Invoices API
- Guides
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
Get a User by Id
Retrieve a single User identified by its unique identifier.
GET
/
api
/
v3
/
users
/
{id}
curl --request GET \
--url https://{host}/api/v3/users/{id} \
--header 'Authorization: <authorization>'
{
"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>",
"name": "<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>"
}
]
}
Headers
API key. Value must be formatted like so: lucca application={api_key}
.
Path Parameters
ID of the user.
Query Parameters
Comma-separated list of fields of the user to include in responses. Extended data can be retrieved with ?fields=extendedData
.
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://{host}/api/v3/users/{id} \
--header 'Authorization: <authorization>'
{
"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>",
"name": "<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>"
}
]
}