Person management
Journal management
API documentation
Account management
Persons
Journal
Profile
Table of contents
The profile endpoint is used to get and set the current user's profile information.
This will probably not be used often, but it can be useful.
Get the information about the logged user
This endpoint gets the information about the logged user. This endpoint is there to make sure that the API works.
URL parameters
This endpoint does not have any parameters.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The type of the resource.
The ID of the user.
The first name of the user.
The last name of the user.
The nickname of the user.
The email of the user.
The birth date of the user, in Unix timestamp format.
The link to access the user.
{
"data": {
"type":
"user"
,
"id":
"1"
,
"attributes": {
"first_name":
"Monica"
,
"last_name":
"Geller"
,
"nickname":
"Godzilla"
,
"email":
"admin@admin.com"
,
"born_at":
1715145600
},
"links": {
"self":
"https://peopleos.cloud/api/me"
}
}
}
Update the information about the logged user
This endpoint updates the information about the logged user.
Only the logged user can update these fields.
If the email is changed, the system will send a new verification email to verify the new email address, and unless the user verifies the new email address, he/she will not be able to access the account.
Please note that your password can not be changed through the API at the moment.
URL parameters
This endpoint does not have any parameters.
Query parameters
The first name of the user. Max 255 characters.
The last name of the user. Max 255 characters.
The nickname of the user. Max 255 characters.
The email of the user. This email should be unique in the instance, and we will validate the email format. Max 255 characters.
The birth date of the user. Format: YYYY-MM-DD. Example: 1985-03-15
Response attributes
The type of the resource.
The ID of the user.
The first name of the user.
The last name of the user.
The nickname of the user.
The email of the user.
The birth date of the user, in Unix timestamp format.
The link to access the user.
{
"data": {
"type":
"user"
,
"id":
"1"
,
"attributes": {
"first_name":
"Dwight"
,
"last_name":
"Schrute"
,
"nickname":
"Dwightchou"
,
"email":
"dwight.schrute@dundermifflin.com"
,
"born_at":
479692800
},
"links": {
"self":
"https://peopleos.cloud/api/me"
}
}
}
Get the timezone of the logged user
This endpoint retrieves the timezone information of the currently logged in user. The timezone is stored in the database as a string, and is in
IANA format
(e.g.,
America/New_York
,
Europe/London
).
URL parameters
This endpoint does not have any parameters.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The timezone of the user in IANA format.
{
"data": {
"type":
"timezone"
,
"attributes": {
"timezone":
"America/New_York"
},
"links": {
"self":
"https://peopleos.cloud/api/me"
}
}
}
Update the timezone of the logged user
This endpoint updates the timezone of the currently logged in user.
The timezone must be a valid
IANA timezone identifier
(e.g.,
America/New_York
,
Europe/London
).
URL parameters
This endpoint does not have any parameters.
Query parameters
The timezone of the user in IANA format (e.g., 'America/New_York', 'Europe/London').
Response attributes
The updated timezone of the user in IANA format.
{
"data": {
"type":
"timezone"
,
"attributes": {
"timezone":
"Europe/Paris"
},
"links": {
"self":
"https://peopleos.cloud/api/me"
}
}
}
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on June 30, 2025.