LoginStart for Free

Users

Get the specified user.

get
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
200
the user object
application/json
get
GET /api/users/{user-id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}

Update an existing user.

put
Authorizations
Path parameters
user-idstringRequired

numeric user id

Body
idinteger · int64Optional
firstNamestringRequired
lastNamestringRequired
emailstringRequired
timezonestring · enumOptionalPossible values:
positionstringOptional
departmentstringOptional
avatarUrlstringRead-onlyOptional
languagestring · enumOptionalPossible values:
regionstring · enumOptionalPossible values:
rolestring · enumOptionalPossible values:
shiftColorstringOptional

Optional hex-color code for the user's shifts in schedules calendars

mutedUntilstring · date-timeOptional

Date in ISO-8601

createdAtstring · date-timeOptional

Date in ISO-8601

updatedAtstring · date-timeOptional

Date in ISO-8601

Responses
200
the updated user
application/json
put
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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}
200

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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}

Delete the specified user.

delete
Authorizations
Path parameters
user-idstringRequired

numeric user id

Responses
204
if deletion was successful
delete
DELETE /api/users/{user-id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

if deletion was successful

No content

List existing users.

get
Authorizations
Query parameters
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50
Responses
200
list of users
application/json
get
GET /api/users HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-07-08T08:40:44.719Z",
    "createdAt": "2025-07-08T08:40:44.719Z",
    "updatedAt": "2025-07-08T08:40:44.719Z"
  }
]

Create a new user. Requires ADMIN privileges.

post

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",
 }
Authorizations
Query parameters
send-no-invitationbooleanOptional

Provide ?send-no-invitation=true if you do not wish to send an invitation email.

Default: false
Body
firstNamestringRequired
lastNamestringRequired
emailstringRequired
timezonestring · enumOptionalPossible values:
positionstringOptional
departmentstringOptional
avatarUrlstringRead-onlyOptional
languagestring · enumOptionalPossible values:
regionstring · enumOptionalPossible values:
rolestring · enumOptionalPossible values:
shiftColorstringOptional

Optional hex-color code for the user's shifts in schedules calendars

Responses
201
Created. The URI of the created user entity is included in the Location header and the user object is included in the body.
application/json
post
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"
}
201

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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}

Get the currently authenticated user.

get
Authorizations
Responses
200
user object
application/json
get
GET /api/users/current HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}

Update the current user.

put
Authorizations
Body
firstNamestringRequired
lastNamestringRequired
emailstringRequired
timezonestring · enumOptionalPossible values:
positionstringOptional
departmentstringOptional
avatarUrlstringRead-onlyOptional
languagestring · enumOptionalPossible values:
regionstring · enumOptionalPossible values:
rolestring · enumOptionalPossible values:
shiftColorstringOptional

Optional hex-color code for the user's shifts in schedules calendars

Responses
200
the updated user
application/json
put
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"
}
200

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-07-08T08:40:44.719Z",
  "createdAt": "2025-07-08T08:40:44.719Z",
  "updatedAt": "2025-07-08T08:40:44.719Z"
}
PreviousSeriesNextContacts

Was this helpful?