List people with search or filter

post

https://platform.{env}.simpplr.com/v1/identity/people/list

You can filter by standard fields (like department, division, title) or custom fields (ending with __c, like team__c).

Example request payload showing filter applied on a standard field (department) and a custom field (team__c): The query finds users in one of the two Marketing department teams.

{
  "pageSize": 10,
  "department": ["Marketing"],
  "team__c": ["Branding Brainiacs", "Ad-Vengers"]
}

Body Params

Get people list

sortBy

string

List of fields to sort by. If sortBy is not provided, the default sort will be by userId.

sortOrder

string

Order in which to sort the results. Valid values are ASC (ascending) or DESC (descending).

pageSize

integer

≤ 200

Number of items per page. Default value is 10.

pageToken

string

A cursor to use in pagination. Should be nextPageToken received in previous page response.

includeTotal

boolean

Defaults to false

Whether to include the total user count in the response

string

Query string for searching users (supports first name and last name).

timezone

array of strings

List of timezones to filter by.

timezone

title

array of strings

List of titles to filter by.

title

userType

array of strings

List of user types to filter by.

userType

division

array of strings

List of divisions to filter by.

division

department

array of strings

List of departments to filter by.

department

businessUnit

array of strings

List of business units to filter by.

businessUnit

companyName

array of strings

List of company names to filter by.

companyName

startDate

Filter by start date range. Can be either an object with start/end dates or a relative date string.

workAnniversary

Filter by work anniversary date range. Can be either an object with start/end dates or a relative date string. The difference between start and end dates cannot be more than 90 days.

birthAnniversary

Filter by birth anniversary date range. Can be either an object with start/end dates or a relative date string. The difference between start and end dates cannot be more than 90 days.

state

array of strings

List of states to filter by.

state

city

array of strings

List of cities to filter by.

city

country

array of strings

List of countries to filter by.

country

location

array of objects

List of location objects.

One of the entries should match for user record to appear in response.

Atleast one of city, state & country should be in an entry.

With in an entry all given props (city, state, country) should match what set for a user.

location

customField

array of strings

Filter property name will be UUID or string endig with __c.

Value passed must be an array of strings.

customField

Responses

200Success

400Bad Request - Invalid Input

401Authorize error

403Forbidden error