curl --request GET \
--url https://app.trelica.com/api/people/v1 \
--header 'Authorization: Bearer <token>'{
"next": "https://app.trelica.com/api/people/v1?after=eyJpZCI6IjEyM2U0NTY3ZTg5YjEyZDMifQ&limit=100",
"results": [
{
"id": "123e4567e89b12d3a456426614174000",
"employeeType": "Part-time",
"personType": "Employee",
"aliases": [
"john.doe@example.com",
"john@example.com",
"j.doe@example.com",
"johnny.d@example.com"
],
"userName": "johndoe123",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"jobTitle": "Customer Success Manager",
"organizationalUnit": "/",
"loginName": "johndoe",
"employeeId": "123",
"status": "Active",
"lineManager": {
"id": "765e4321b98e21d3b456426614174000",
"personType": "User",
"name": "Jane Smith",
"email": "jane.smith@example.com"
},
"teams": [
{
"id": "65207c3ffa0d2abb07955316",
"name": "Customer Success"
}
],
"createdBy": {
"userId": "321cba98-765e-4321-0d3b-456789abcdef",
"name": "System",
"email": "admin@example.com"
},
"createdDtm": "2020-03-09T06:09:26Z",
"lastModifiedBy": {
"userId": "321cba98-765e-4321-0d3b-456789abcdef",
"name": "System",
"email": "admin@example.com"
},
"lastModifiedDtm": "2024-05-26T01:01:43Z"
}
]
}List people
Returns a paginated list of the people in your organization. Use filter and
q to narrow the results, and follow the next link (also provided in the
link response header) to page through large result sets.
Required scope: People.Read (Read-only access to people and teams)
curl --request GET \
--url https://app.trelica.com/api/people/v1 \
--header 'Authorization: Bearer <token>'{
"next": "https://app.trelica.com/api/people/v1?after=eyJpZCI6IjEyM2U0NTY3ZTg5YjEyZDMifQ&limit=100",
"results": [
{
"id": "123e4567e89b12d3a456426614174000",
"employeeType": "Part-time",
"personType": "Employee",
"aliases": [
"john.doe@example.com",
"john@example.com",
"j.doe@example.com",
"johnny.d@example.com"
],
"userName": "johndoe123",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"jobTitle": "Customer Success Manager",
"organizationalUnit": "/",
"loginName": "johndoe",
"employeeId": "123",
"status": "Active",
"lineManager": {
"id": "765e4321b98e21d3b456426614174000",
"personType": "User",
"name": "Jane Smith",
"email": "jane.smith@example.com"
},
"teams": [
{
"id": "65207c3ffa0d2abb07955316",
"name": "Customer Success"
}
],
"createdBy": {
"userId": "321cba98-765e-4321-0d3b-456789abcdef",
"name": "System",
"email": "admin@example.com"
},
"createdDtm": "2020-03-09T06:09:26Z",
"lastModifiedBy": {
"userId": "321cba98-765e-4321-0d3b-456789abcdef",
"name": "System",
"email": "admin@example.com"
},
"lastModifiedDtm": "2024-05-26T01:01:43Z"
}
]
}Authorizations
OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as Authorization: Bearer <token>.
Query Parameters
A SCIM-style filter expression restricting the items returned. See the Filtering section of the introduction for the operators and syntax; the filterable fields are listed per resource.
Filterable fields
- string:
aliases,costCenter,costCenterId,createdBy.email,createdBy.name,createdBy.userId,email,employeeId,firstName,id,jobTitle,lastModifiedBy.email,lastModifiedBy.name,lastModifiedBy.userId,lastName,location,locationCountryCode,locationId,locationTimezone,loginName,organizationalUnit,personType,personalAddress.city,personalAddress.countryCode,personalAddress.stateOrProvince,personalAddress.streetAddress1,personalAddress.streetAddress2,personalAddress.zipOrPostalCode,phoneNumber,status,teams[id],teams[name],timezone - date:
createdDtm,lastModifiedDtm,leavingDate,startDate - custom fields:
customFields.<name>
Filter examples
email eq "john.doe@example.com"— The person with this email addressfirstName sw "Jan"— People whose first name starts with "Jan"teams[name eq "Developers"]— People in the Developers teamnot (leavingDate pr)— People with no leaving datestatus eq "Active" and lastModifiedDtm ge "2024-01-01"— Active people modified on or after 1 Jan 2024
Free-text search across the resource's displayable fields.
Only return items modified at or after this ISO-8601 timestamp.
Only return items modified at or before this ISO-8601 timestamp.
Opaque pagination cursor supplied by SaaS Manager via the link response header and the next field.
Maximum number of items to return per page (default 100, maximum 1000).
1 <= x <= 1000Was this page helpful?