/people

get

https://developer.interactgo.com/api/people

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint is the main interface for searching your people directory.

If a searchTerm is specified, this must be more than 2 characters long

📘
Interact's search is configured to return a maximum of 10000 results even with paging, therefore if your system contains more than 10000 people, not all will be accessible.
To access all profiles in this scenario, you should specify some sort of filter to limit the results. The most effective way for this is to specify the alphabetFilter and make a call for each letter of the alphabet.

🚧
Deprecated: JobDescription
The JobDescription field is deprecated and will always return null. You should use the /api/people/{id}/profile endpoint to retrieve this attribute.

Query Params

alphabetFilter

string

If specified this will return only users with the specified letter as an initial

department

string

If specified this will return only users in the specified department

searchTerm

string

If specified, this will return only users for whom the search term appears in their profile. This should be more than 2 characters long

limit

int32

Defaults to 10

This specifies the maximum number of records to be returned - Default is 10, Maximum of 50

offset

int32

This specifies the record number that the search should start with, allowing pagination

managerId

int32

If specified, this will return only users with the manager ID equal to the supplied value.

additionalDepartmentId

int32

If specified, this will return only users with the additional department ID equal to the supplied value.

additionalCompanyId

int32

If specified, this will return only users with the additional company ID equal to the supplied value.

additionalLocationId

int32

If specified, this will return only users with the additional location ID equal to the supplied value.

Response

Deprecated: JobDescription

200200