Person management
Journal management
API documentation
Account management
Persons
Journal
Genders
Table of contents
This endpoint lets you manage the genders in your account.
Genders are used to identify the gender of a person. You can define as many genders as you want. An account comes with a default set of genders, but feel free to add more to your liking.
Get the list of genders
This endpoint gets the list of genders in the account.
Genders are ordered by position.
This call is not paginated, since there should not be too many genders in the account.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The ID of the gender.
The object type. Always 'gender'.
The name of the gender.
The position of the gender.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": [
{
"type":
"gender"
,
"id":
"1"
,
"attributes": {
"name":
"Man"
,
"position":
1
,
"created_at":
1746615348
,
"updated_at":
null
},
"links": {
"self":
"https://peopleos.cloud/api/administration/genders/1"
}
}
,
{
...
}
]
}
Create a new gender
This endpoint creates a new gender. It will return the gender in the response.
URL parameters
No URL parameters are required for this endpoint.
Query parameters
The name of the gender. Maximum 255 characters.
Response attributes
The ID of the gender.
The object type. Always 'gender'.
The name of the gender.
The position of the gender.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
{
"type":
"gender"
,
"id":
"1"
,
"attributes": {
"name":
"Man"
,
"position":
1
,
"created_at":
1746615348
,
"updated_at":
null
},
"links": {
"self":
"https://peopleos.cloud/api/administration/genders/1"
}
}
}
}
Show a gender
This endpoint shows a gender.
URL parameters
The ID of the gender to show.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The ID of the gender.
The object type. Always 'gender'.
The name of the gender.
The position of the gender.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
{
"type":
"gender"
,
"id":
"1"
,
"attributes": {
"name":
"Man"
,
"position":
1
,
"created_at":
1746615348
,
"updated_at":
null
},
"links": {
"self":
"https://peopleos.cloud/api/administration/genders/1"
}
}
}
}
Update a gender
This endpoint updates a gender. It will return the gender in the response.
URL parameters
The ID of the gender to update.
Query parameters
The name of the gender. Maximum 255 characters.
The position of the gender.
Response attributes
The ID of the gender.
The object type. Always 'gender'.
The name of the gender.
The position of the gender.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
{
"type":
"gender"
,
"id":
"1"
,
"attributes": {
"name":
"Man"
,
"position":
1
,
"created_at":
1746615348
,
"updated_at":
null
},
"links": {
"self":
"https://peopleos.cloud/api/administration/genders/1"
}
}
}
}
Delete a gender
This endpoint deletes a gender. It will return a 204 No Content response.
URL parameters
The ID of the gender to delete.
Query parameters
No query parameters are available for this endpoint.
Response attributes
This endpoint returns a 204 No Content response with no body.
204 No Content
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on July 3, 2025.