Returns a paginated list of people registered in the Organization module.
URL
{RMUrl}/api/Organization/people[?[[&]$filter=<filter>][[&]page=<Page>][[&]page_size=<PageSize>][[&]$orderby=<field1[desc],field2[desc]…fieldN[desc]>]]
REQUEST METHOD
GET
URL PARAMETERS
page: Number of the page to be displayed. Valid values: 1 to the maximum number of pages. If omitted, the value 1 is used. If the value is greater than the maximum number of pages, a blank list will be returned.
page_size: Number of items displayed per page. Valid values: 1 to 1,000. If omitted, the default value of 10 is used.
filter: Query based on the OData protocol syntax for configuring filters. The fields supported are listed below. See the examples to view the operations allowed.
orderby: Orders the people listed on the page by field. To order by more than one field, use a comma between the field names. For descending order, add the word "desc" for each desired field. The supported fields are listed below.
FIELDS SUPPORTED BY FILTER
Guid Id;
string Name;
string Description;
string Email;
string Phone;
string AdditionalInformation;
string Login;
string Status;
For detailed information on filters as supported operators, which filters apply to which data types, and more examples, see Appendix 3: Filters.
REQUEST EXAMPLES
The first ten people (by default, ten people are listed at a time):
{RMUrl}/api/Organization/people
People 11 through 20 (second page)
{RMUrl}/api/Organization/people?page=2
Filter by person ID:
{RMUrl}/api/Organization/people?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filter by "Jane" in the "Name" field:
{RMUrl}/api/Organization/people?$filter=substringof('Jane',Name)
SUCCESS RESPONSE
List of objects with information on the people according to the filter and page size specified.
People[].
The People object is in the following format:
People
{
Guid Id;
string Name;
string Description;
string Email;
string Phone;
string AdditionalInformation;
string Login;
string Status;
object CustomAttributes[];
}
The Status field accepts the following values: "Active", or "Blocked". This field does not accept filters with the substrigof operator. To return the list of users without a username, use ?$filter=Login eq null.
For more information on custom attributes, see Appendix 1: Attribute Types.
SUCCESS RESPONSE EXAMPLES
[
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"John Smith"
"Description":"Employee - HR department",
"Email":"jsmith@example.com",
"Phone":"+1 (646) 555-0000",
"AdditionalInformation":"HR manager",
"Login":"jsmith",
"Status":"Active"},
"CustomAttributes":{
"link":"https:\/\/abccompany.com",
"text":"Text"
}
},
{
"Id":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"James Hoffman"
"Description":"Employee – Office Security",
"Email":"jhoffman@example.com",
"Phone":"+1 (646) 555-0000",
"AdditionalInformation":"Night shift",
"Login":"jhoffman",
"Status":"NoAccess"}
},
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"Jane Doe"
"Description":"Employee – Marketing department",
"Email":"jdoe@example.com",
"Phone":"+1 (646) 555-0000",
"AdditionalInformation":"Marketing manager",
"Login":"janedoe",
"Status":"Blocked"
}
]