Person
get
https://app.trelica.com/api/
people/v1/{id}
Get attributes for a person
patch
https://app.trelica.com/api/
people/v1/{id}
Set attributes for a person
Note that the
id field can either the Trelica Person ID or an email address.https://app.trelica.com/api/people/v1/[email protected]/apps will retrieve all apps used by Jane.People records in Trelica represent identities that may come from multiple sources - for example an Identity Provider and an HR system may be connected to Trelica and elements of the identity will come from these different sources.
This means that not all fields relating to a person may be updated.
The API will update fields that may be updated in the user interface. Bear in mind that this may vary from person identity to person identity (e.g. one person might have a termination date already supplied by an HR system, so manually updating it will have no effect).
Attribute | Type | Description |
|---|---|---|
leavingDate | date | (ISO format) Date that the person left the organization or is due to leave. e.g. 2022-01-15 . Passing null clears the date. |
startDate | date | (ISO format) Date that the person joined the organization. Passing null clears the date. |
costCenter | string | Cost center |
location | string | Location |
jobTitle | string | Job title |
personType | enum | Employee | Contractor | ServiceAccount | External |
{
"leavingDate": "2020-02-01"
}
Last modified 6mo ago