Skip to content

Create person

POST
/api/people
curl --request POST \
--url http://localhost:3000/api/people \
--header 'Content-Type: application/json' \
--cookie session=<session> \
--data '{ "fullName": "example", "email": "[email protected]", "phone": "example", "jobTitle": "example", "department": "example", "employeeId": "example", "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "profileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "active", "startDate": "2026-04-15", "notes": "example" }'
Media type application/json
object
fullName
required
string
email

Unique

string format: email
phone
string
jobTitle
string
department
string
employeeId
string
siteId
string format: uuid
profileId

Link to a login profile (unique)

string format: uuid
status
string
default: active
startDate
string format: date
notes
string

Person created

Media type application/json
object
data
object
id
required
string format: uuid
fullName
required
string
email
string
nullable
phone
string
nullable
jobTitle
string
nullable
department
string
nullable
employeeId
string
nullable
siteId
string format: uuid
nullable
siteName
string
nullable
profileId
string format: uuid
nullable
status
required
string
default: active
startDate
string format: date
nullable
notes
string
nullable
profile
object
id
string format: uuid
email
string
role
string
isActive
boolean
assetCount

Open assignments (list endpoint)

integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"data": {
"status": "active"
}
}

Full name is required

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Not authenticated

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Email or profile already linked to another person

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}