Returns a paginated list of the groups of people registered in the Organization module.
URL
{RMUrl}/api/Organization/groups[?[[&]$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 groups 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 AdditionalInformation;
object Responsible;
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 groups (by default, ten groups are listed at a time):
{RMUrl}/api/Organization/groups
Groups 11 through 20 (second page):
{RMUrl}/api/Organization/groups?page=2
Filter by group ID:
{RMUrl}/api/Organization/groups?$filter=Id eq guid'6fe49ce4-56d4-475f-9483-1adca6b2976c'
Filter by "Team" in the "Name" field:
{RMUrl}/api/Organization/groups?$filter=substringof('Team',Name)
SUCCESS RESPONSE
List of objects with information on the groups according to the filter and page size specified.
Group[].
The Group object is in the following format:
Group
{
Guid Id;
string Name;
string Description;
string Email;
string AdditionalInformation;
object Responsible;
}
For more information on custom attributes, see Appendix 1: Attribute Types.
SUCCESS RESPONSE EXAMPLES
[
{
"Id":"6fe49ce4-56d4-475f-9483-1adca6b2976c",
"Name":"IT Team",
"Description":"Employees - Information Technology department (NY)",
"Email":"informationtech_ny@example.com",
"AdditionalInformation":"IT team at ABC Company’s New York branch",
"Responsible":{"Email":"pgraham@abccompany.com",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Paul Graham",
"Phone":"+1 (646) 555-0000"},
},
{
"Id":"63e5fe02-5773-4a49-ba13-22506f022316",
"Name":"Managers",
"Description":"Group of department managers at ABC Company",
"Email":"managers@abccompany.com",
"AdditionalInformation":"Group of users who are managers at ABC Company",
"Responsible":{"Email":"pgraham@abccompany.com",
"Id":"00d6dccf-1a9c-11e1-b470-0800270094a6",
"Name":"Paul Graham",
"Phone":"+1 (646) 555-0000"},
}
]