Retrieves all user groups, optionally filtered via OData query options.

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult containing the list of user groups.

user_group
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier
sales_organization_id

Foreign key of the sales organization this user group belongs to.

 globally unique identifier
licence_group_id

Foreign key of the licence group this user group is scoped to.

 globally unique identifier
name

Name of this user group.

 string
archived

Indicates whether this user group has been archived (no longer assignable).

 boolean
allow_service_app

allowed using app?

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

 date

Response Formats

application/json, text/json

Sample: 
{
  "id": "fa629f87-d459-4da2-ba8a-ce9227a57b4f",
  "sales_organization_id": "70b63268-94d3-4346-a01a-af0180326f57",
  "licence_group_id": "ebe7e8f3-6552-47ca-adf7-8e40abc1327b",
  "name": "sample string 4",
  "archived": true,
  "allow_service_app": true,
  "modified_dateutc": "2026-09-16T10:11:59.1101891+00:00"
}

application/xml, text/xml

Sample: 
<user_group xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <allow_service_app>true</allow_service_app>
  <archived>true</archived>
  <id>fa629f87-d459-4da2-ba8a-ce9227a57b4f</id>
  <licence_group_id>ebe7e8f3-6552-47ca-adf7-8e40abc1327b</licence_group_id>
  <modified_dateutc>2026-09-16T10:11:59.110Z</modified_dateutc>
  <name>sample string 4</name>
  <sales_organization_id>70b63268-94d3-4346-a01a-af0180326f57</sales_organization_id>
</user_group>