GET /api/v3/userGroup

Gets a list of user groups

GetUserGroupsV3 Paginated

Paginated endpoint — This API returns paginated results. Use the pageNumber and pageSize query parameters to control which page of results is returned. The response includes pagination metadata in the response headers. See the Pagination guide for details.

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type.

Query Parameters

Name	Description	Type	Required
filter		string (string)	Optional
pageSize	The number of elements to return in a page	integer (int32)	Optional
pageNumber	The current page number	integer (int32)	Optional

Filters

Filter	Description	Type	Operators
email	Email Address	String	equals not equals one of like not like not one of
fullName	Full Name	String	equals not equals one of like not like not one of
systemUserCode	Username	String	equals not equals one of like not like not one of
userGroupName	User Group Name	String	equals not equals one of like not like not one of

Response Headers

This endpoint returns pagination metadata in the response headers.

Header	Type	Description
PageNumber	integer	The current page number (1-based).
PageSize	integer	The maximum number of items per page.
TotalNumberOfRecords	integer	The total number of records matching the query across all pages.
TotalPages	integer	The total number of pages. Increment pageNumber until it equals this value to retrieve all results.

See the Pagination guide for iteration examples and best practices.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

UserGroupResponse

Property	Description	Type
description	The user group description	string
lastUpdated	The last time a member was inserted, updated, or deleted from the group	string (date-time)
memberCount	The number of users in this group	integer (int32)
userGroupId	The user group identifier	integer (int32)
userGroupName	The user group name	string

Example Response application/json

[
  {    "description": "string",    "lastUpdated": "2026-03-30",    "memberCount": 1,    "userGroupId": 1,    "userGroupName": "string"
  }
]