People

get
https://app.trelica.com/api/
people/v1
List people
Simple queries
The q parameter lets you pass a simple text query. This searches the following fields:
Field value matches query exactly
Field value contains query text
Person ID
Name
Email
​
Example filters
Filter
Results
not (leavingDate pr)
People without a leaving date
teams[name eq "Devs"]
People in the team called Devs
firstName sw "Jan"
People whose names start with 'Jan' e.g. 'Janet', 'Jane'
Data structure
Person
Attribute
Type
Description
id
string
Unique identified for a person
firstName
string
First name
lastName
string
Last name
email
string
Email
aliases
array
Array of email alias strings linked to person
jobTitle
string
Job title
personType
enum
Employee | Contractor | ServiceAccount | External
location
string
Location
teams
array
Array of team objects​
costCenter
string
Cost center
startDate
date
(ISO format) Date that the person joined the organization. 
Passing null clears the date.
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.
createdDtm
datetime
(ISO format) Date the person was created in Trelica
lastModifiedDtm
datetime
(ISO format) Date the person was last modified in Trelica
createdBy
object
​Compact User object
lastModifiedBy
object
​Compact User object
Team
Attribute
Type
Description
id
string
Team ID
name
string
Team name
​

Field value matches query exactly	Field value contains query text
Person ID	Name
Email

Filter	Results
`not (leavingDate pr)`	People without a leaving date
`teams[name eq "Devs"]`	People in the team called Devs
`firstName sw "Jan"`	People whose names start with 'Jan' e.g. 'Janet', 'Jane'

Attribute	Type	Description
id	string	Unique identified for a person
firstName	string	First name
lastName	string	Last name
email	string	Email
aliases	array	Array of email alias strings linked to person
jobTitle	string	Job title
personType	enum	`Employee` \| `Contractor` \| `ServiceAccount` \| `External`
location	string	Location
teams	array	Array of team objects
costCenter	string	Cost center
startDate	date	(ISO format) Date that the person joined the organization. Passing `null` clears the date.
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.
createdDtm	datetime	(ISO format) Date the person was created in Trelica
lastModifiedDtm	datetime	(ISO format) Date the person was last modified in Trelica
createdBy	object	Compact User object
lastModifiedBy	object	Compact User object

Attribute	Type	Description
id	string	Team ID
name	string	Team name

Users

Person

Last modified 5mo ago