Users
numeric user id
the user object
GET /api/users/{user-id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
the user object
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
numeric user id
Optional hex-color code for the user's shifts in schedules calendars
Date in ISO-8601
Date in ISO-8601
Date in ISO-8601
the updated user
PUT /api/users/{user-id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 314
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
the updated user
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
the maximum number of results when paging through a list of entities.
50
list of users
GET /api/users HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
list of users
[
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
]
Sample request
Request URL: https://api.ilert.com/api/users
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"position": "Software Engineer",
}
Response
{
"id": 2188373,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"position": "Software Engineer",
"timezone": "Europe/Berlin",
"language": "de",
"role": "RESPONDER",
}
Provide ?send-no-invitation=true if you do not wish to send an invitation email.
false
Optional hex-color code for the user's shifts in schedules calendars
Created. The URI of the created user entity is included in the Location header and the user object is included in the body.
POST /api/users HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text"
}
Created. The URI of the created user entity is included in the Location header and the user object is included in the body.
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
user object
GET /api/users/current HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
user object
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
Optional hex-color code for the user's shifts in schedules calendars
the updated user
PUT /api/users/current HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text"
}
the updated user
{
"id": 1,
"firstName": "text",
"lastName": "text",
"email": "text",
"timezone": "Europe/Berlin",
"position": "text",
"department": "text",
"avatarUrl": "text",
"language": "de",
"region": "DE",
"role": "STAKEHOLDER",
"shiftColor": "text",
"mutedUntil": "2025-08-19T14:32:18.082Z",
"createdAt": "2025-08-19T14:32:18.082Z",
"updatedAt": "2025-08-19T14:32:18.082Z"
}
Was this helpful?