Cyan Web API - Version 1

GET api/userGroups/{userGroupId}

            Gets a UserGroup.

Request Information

Parameters

Name	Description	Additional information
userGroupId		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "userGroupId": "ffc5dfc2-3b37-4428-ae5f-c8f91df7bed5",
  "tenantId": "4caaf208-6185-43a7-8176-e0d660db4555",
  "lookupKey": "sample string 3",
  "name": "sample string 4",
  "description": "sample string 5",
  "isDefault": true,
  "createdDateUtc": "2026-06-25T19:49:21.5666518+00:00",
  "updatedDateUtc": "2026-06-25T19:49:21.5666518+00:00"
}

application/xml, text/xml

Sample:

<UserGroupRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-06-25T19:49:21.5666518+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-25T19:49:21.5666518+00:00</UpdatedDateUtc>
  <Description>sample string 5</Description>
  <IsDefault>true</IsDefault>
  <LookupKey>sample string 3</LookupKey>
  <Name>sample string 4</Name>
  <TenantId>4caaf208-6185-43a7-8176-e0d660db4555</TenantId>
  <UserGroupId>ffc5dfc2-3b37-4428-ae5f-c8f91df7bed5</UserGroupId>
</UserGroupRepresentation>