GET/ Groups

This API returns a collection of groups for your organization. A group represents an individual node within your organization’s hierarchical structure to which employees are assigned. Groups help segment your employee population and limit user access to employee records.

Method

GET

Resource Information

Requires authentication?	YES
Response formats	JSON

Parameters

Parameter	Required	Description
page	No	specifies the page number from where you want to begin accessing records

Filtering

The fields in the table below can be used in the query string of a GET request, for example:
GET https://<server>/v1/employees?firstName=John

Currently, it is only possible to query for exact values (no wildcards or partial matches)

Example
Request Example
GET https://<server>/v1/groups?page_size=5&page=1
Response Example:

{
 ""searchResult"": [
 {
 ""managed"": false,
 ""name"": ""ABC Corporation"",
 ""id"": 3119
 },
 {
 ""managed"": false,
 ""name"": ""Acme Inc"",
 ""id"": 3121
 },
 {
 ""managed"": true,
 ""name"": ""Branch 123"",
 ""id"": 3120
 },
 {
 ""managed"": true,
 ""name"": ""Branch 222"",
 ""id"": 3122
 },
 {
 ""managed"": true,
 ""name"": ""G2 2 level bun-loc"",
 ""id"": 3118
 }
 ],
 ""links"": [
 {
 ""href"": ""/v1/groups"",
 ""rel"": ""self""
 },
 {
 ""href"": ""/v1/groups?page=1"",
 ""rel"": ""first""
 },
 {
 ""href"": ""/v1/groups?page=1"",
 ""rel"": ""last""
 },
 {
 ""href"": ""/v1/groups?page=1"",
 ""rel"": ""next""
 },
 {
 ""href"": ""/v1/groups?page=1"",
 ""rel"": ""previous""
 }
 ]
}

Single Record Example
Request Example: GET https://<server>/v1/groups/
Single Record Response Example

{
 ""numChild"": 1,
 ""name"": ""Acme Inc"",
 ""links"": [
 {
 ""href"": ""/v1/groups/3121"",
 ""rel"": ""self""
 },
 {
 ""href"": ""/v1/groups/3121/users"",
 ""rel"": ""users""
 }
 ],
 ""id"": 3121
}

User Group Assignment Example
Request Example: GET https://<server>/v1/groups//users
Response Example:

{
 ""searchResult"": [
 {
 ""retired"": false,
 ""firstName"": ""John"",
 ""title"": Manager,
 ""lastName"": ""Smith"",
 ""emailAddress"": john@acme.com,
 ""groups"": [
 {
 ""name"": ""Branch 123"",
 ""id"": 3118
 }
 ],
 ""fullName"": ""John Smith"",
 ""id"": 265098
 }
 ],
 ""links"": [
 {
 ""href"": ""/v1/groups/3118/users"",
 ""rel"": ""self""
 }
 ]
}