GET/Groups

Gets a list of groups.

This API operation gets only an internal group or a dynamic group; it cannot get an external group.
This API operation gets only members and group members of the group type. It cannot get group members of the team type.

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Groups

Query Parameters

ParameterTypeDescription
startIndex integer 

Offset


default : 1
minimum : 1 
count integer 

Number of items to get


default : 100
minimum : 0
maximum : 100 
filter string 

Filter.
Groups can only be filtered by the displayName field (eq comparison).
+ must be encoded to %2B.


example : displayName eq "group name" 
excludedAttributes string 

Attributes to exclude from the return value


Allowed values : members 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

See Get a Long-Lived Token for SCIM.


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL

 
totalResults integer 

Total number of results

 
startIndex integer 

Offset

 
itemsPerPage integer 

Number of resources returned

 
resources array (ScimGroupResponse) 

Group information

 

ScimGroupResponse

PropertyTypeDescription
schemas array (string) 

Schema URL

 
id string 

Group ID

 
externalId string 

ID managed by the SCIM client

 
displayName string 

Group name

 
members array (ScimGroupMember) 

List of group members

 
meta object (meta) 
 

ScimGroupMember

PropertyTypeDescription
value string 

Group member ID (member ID or group ID)


required 
type string 

Group member type


Allowed values : USER, GROUP
readOnly : true 
display string 

Group member name (member name or group name)


readOnly : true 
$ref string 

Reference URL

Gets the detailed information of a group member.


readOnly : true 

meta

PropertyTypeDescription
resourceType string 

Resource type


Allowed values : USER, GROUP 
created string 

Creation date

 
lastModified string 

Last update date

 
location string 

Resource URI

 

HTTP 400

Bad Request