GET api/UserGroup/{id}

Returns specific User Group based on accountId and userGroupId

Request Information

URI Parameters

Name	Description	Type	Additional information
id	unique identifier of User Group	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

ApiResponseOfGetUserGroupResponseWithSubGroups

Name	Type	Additional information
IsSuccess	boolean	None.
Errors	Collection of string	None.
Data	GetUserGroupResponseWithSubGroups	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Data": {
    "Id": "69acfc84-b2e9-4064-a949-af3b6d0f4f81",
    "Name": "sample string 2",
    "UserGroupType": 0,
    "Users": [
      {
        "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
        "Username": "sample string 2",
        "EmailAddress": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "LoginProviders": [
          {
            "Id": "82218280-877b-48ff-868b-826c1371a0b3",
            "ProviderName": "sample string 2",
            "ProviderKey": "sample string 3",
            "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
          },
          {
            "Id": "82218280-877b-48ff-868b-826c1371a0b3",
            "ProviderName": "sample string 2",
            "ProviderKey": "sample string 3",
            "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
          }
        ],
        "Roles": [
          "sample string 1",
          "sample string 2"
        ],
        "IsActive": true,
        "IsPrivateCustomer": true
      },
      {
        "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
        "Username": "sample string 2",
        "EmailAddress": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "LoginProviders": [
          {
            "Id": "82218280-877b-48ff-868b-826c1371a0b3",
            "ProviderName": "sample string 2",
            "ProviderKey": "sample string 3",
            "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
          },
          {
            "Id": "82218280-877b-48ff-868b-826c1371a0b3",
            "ProviderName": "sample string 2",
            "ProviderKey": "sample string 3",
            "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
          }
        ],
        "Roles": [
          "sample string 1",
          "sample string 2"
        ],
        "IsActive": true,
        "IsPrivateCustomer": true
      }
    ],
    "Children": [
      {
        "Id": "368b6539-a2bf-4062-840a-7db2204457a1",
        "Name": "sample string 2",
        "UserGroupType": 0,
        "Users": [
          {
            "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
            "Username": "sample string 2",
            "EmailAddress": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "LoginProviders": [
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              },
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              }
            ],
            "Roles": [
              "sample string 1",
              "sample string 2"
            ],
            "IsActive": true,
            "IsPrivateCustomer": true
          },
          {
            "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
            "Username": "sample string 2",
            "EmailAddress": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "LoginProviders": [
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              },
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              }
            ],
            "Roles": [
              "sample string 1",
              "sample string 2"
            ],
            "IsActive": true,
            "IsPrivateCustomer": true
          }
        ],
        "InstitutionNumber": "sample string 3",
        "CommuneNumber": "sample string 4",
        "ZipCode": "sample string 5",
        "City": "sample string 6",
        "Email": "sample string 7",
        "HasWs17Agreement": true,
        "LastSynchonized": "2026-03-02T03:58:51.9670208+00:00",
        "LastSynchonizationError": "sample string 9",
        "Address": "sample string 10"
      },
      {
        "Id": "368b6539-a2bf-4062-840a-7db2204457a1",
        "Name": "sample string 2",
        "UserGroupType": 0,
        "Users": [
          {
            "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
            "Username": "sample string 2",
            "EmailAddress": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "LoginProviders": [
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              },
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              }
            ],
            "Roles": [
              "sample string 1",
              "sample string 2"
            ],
            "IsActive": true,
            "IsPrivateCustomer": true
          },
          {
            "Id": "bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03",
            "Username": "sample string 2",
            "EmailAddress": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "LoginProviders": [
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              },
              {
                "Id": "82218280-877b-48ff-868b-826c1371a0b3",
                "ProviderName": "sample string 2",
                "ProviderKey": "sample string 3",
                "UserId": "71708f11-943b-42e3-9285-faca20da9b92"
              }
            ],
            "Roles": [
              "sample string 1",
              "sample string 2"
            ],
            "IsActive": true,
            "IsPrivateCustomer": true
          }
        ],
        "InstitutionNumber": "sample string 3",
        "CommuneNumber": "sample string 4",
        "ZipCode": "sample string 5",
        "City": "sample string 6",
        "Email": "sample string 7",
        "HasWs17Agreement": true,
        "LastSynchonized": "2026-03-02T03:58:51.9670208+00:00",
        "LastSynchonizationError": "sample string 9",
        "Address": "sample string 10"
      }
    ],
    "InstitutionNumber": "sample string 3",
    "CommuneNumber": "sample string 4",
    "ZipCode": "sample string 5",
    "City": "sample string 6",
    "Email": "sample string 7",
    "HasWs17Agreement": true,
    "LastSynchonized": "2026-03-02T03:58:51.9670208+00:00",
    "LastSynchonizationError": "sample string 9",
    "Address": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<ApiResponseOfGetUserGroupResponseWithSubGroupsLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
    <d2p1:Address>sample string 10</d2p1:Address>
    <d2p1:Children>
      <d2p1:GetUserGroupResponse>
        <d2p1:Address>sample string 10</d2p1:Address>
        <d2p1:City>sample string 6</d2p1:City>
        <d2p1:CommuneNumber>sample string 4</d2p1:CommuneNumber>
        <d2p1:Email>sample string 7</d2p1:Email>
        <d2p1:HasWs17Agreement>true</d2p1:HasWs17Agreement>
        <d2p1:Id>368b6539-a2bf-4062-840a-7db2204457a1</d2p1:Id>
        <d2p1:InstitutionNumber>sample string 3</d2p1:InstitutionNumber>
        <d2p1:LastSynchonizationError>sample string 9</d2p1:LastSynchonizationError>
        <d2p1:LastSynchonized>2026-03-02T03:58:51.9670208+00:00</d2p1:LastSynchonized>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:UserGroupType>Default</d2p1:UserGroupType>
        <d2p1:Users>
          <d2p1:GetUserResponse>
            <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
            <d2p1:FirstName>sample string 4</d2p1:FirstName>
            <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
            <d2p1:IsActive>true</d2p1:IsActive>
            <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
            <d2p1:LastName>sample string 5</d2p1:LastName>
            <d2p1:LoginProviders>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
            </d2p1:LoginProviders>
            <d2p1:Roles xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d2p1:Roles>
            <d2p1:Username>sample string 2</d2p1:Username>
          </d2p1:GetUserResponse>
          <d2p1:GetUserResponse>
            <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
            <d2p1:FirstName>sample string 4</d2p1:FirstName>
            <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
            <d2p1:IsActive>true</d2p1:IsActive>
            <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
            <d2p1:LastName>sample string 5</d2p1:LastName>
            <d2p1:LoginProviders>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
            </d2p1:LoginProviders>
            <d2p1:Roles xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d2p1:Roles>
            <d2p1:Username>sample string 2</d2p1:Username>
          </d2p1:GetUserResponse>
        </d2p1:Users>
        <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
      </d2p1:GetUserGroupResponse>
      <d2p1:GetUserGroupResponse>
        <d2p1:Address>sample string 10</d2p1:Address>
        <d2p1:City>sample string 6</d2p1:City>
        <d2p1:CommuneNumber>sample string 4</d2p1:CommuneNumber>
        <d2p1:Email>sample string 7</d2p1:Email>
        <d2p1:HasWs17Agreement>true</d2p1:HasWs17Agreement>
        <d2p1:Id>368b6539-a2bf-4062-840a-7db2204457a1</d2p1:Id>
        <d2p1:InstitutionNumber>sample string 3</d2p1:InstitutionNumber>
        <d2p1:LastSynchonizationError>sample string 9</d2p1:LastSynchonizationError>
        <d2p1:LastSynchonized>2026-03-02T03:58:51.9670208+00:00</d2p1:LastSynchonized>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:UserGroupType>Default</d2p1:UserGroupType>
        <d2p1:Users>
          <d2p1:GetUserResponse>
            <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
            <d2p1:FirstName>sample string 4</d2p1:FirstName>
            <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
            <d2p1:IsActive>true</d2p1:IsActive>
            <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
            <d2p1:LastName>sample string 5</d2p1:LastName>
            <d2p1:LoginProviders>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
            </d2p1:LoginProviders>
            <d2p1:Roles xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d2p1:Roles>
            <d2p1:Username>sample string 2</d2p1:Username>
          </d2p1:GetUserResponse>
          <d2p1:GetUserResponse>
            <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
            <d2p1:FirstName>sample string 4</d2p1:FirstName>
            <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
            <d2p1:IsActive>true</d2p1:IsActive>
            <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
            <d2p1:LastName>sample string 5</d2p1:LastName>
            <d2p1:LoginProviders>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
              <d2p1:GetLoginProviderResponse>
                <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
                <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
                <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
                <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
              </d2p1:GetLoginProviderResponse>
            </d2p1:LoginProviders>
            <d2p1:Roles xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>sample string 1</d7p1:string>
              <d7p1:string>sample string 2</d7p1:string>
            </d2p1:Roles>
            <d2p1:Username>sample string 2</d2p1:Username>
          </d2p1:GetUserResponse>
        </d2p1:Users>
        <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
      </d2p1:GetUserGroupResponse>
    </d2p1:Children>
    <d2p1:City>sample string 6</d2p1:City>
    <d2p1:CommuneNumber>sample string 4</d2p1:CommuneNumber>
    <d2p1:Email>sample string 7</d2p1:Email>
    <d2p1:HasWs17Agreement>true</d2p1:HasWs17Agreement>
    <d2p1:Id>69acfc84-b2e9-4064-a949-af3b6d0f4f81</d2p1:Id>
    <d2p1:InstitutionNumber>sample string 3</d2p1:InstitutionNumber>
    <d2p1:LastSynchonizationError>sample string 9</d2p1:LastSynchonizationError>
    <d2p1:LastSynchonized>2026-03-02T03:58:51.9670208+00:00</d2p1:LastSynchonized>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:UserGroupType>Default</d2p1:UserGroupType>
    <d2p1:Users>
      <d2p1:GetUserResponse>
        <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
        <d2p1:LastName>sample string 5</d2p1:LastName>
        <d2p1:LoginProviders>
          <d2p1:GetLoginProviderResponse>
            <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
            <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
            <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
          </d2p1:GetLoginProviderResponse>
          <d2p1:GetLoginProviderResponse>
            <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
            <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
            <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
          </d2p1:GetLoginProviderResponse>
        </d2p1:LoginProviders>
        <d2p1:Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Roles>
        <d2p1:Username>sample string 2</d2p1:Username>
      </d2p1:GetUserResponse>
      <d2p1:GetUserResponse>
        <d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
        <d2p1:FirstName>sample string 4</d2p1:FirstName>
        <d2p1:Id>bf0a51a3-fa7a-46d8-8ae4-890f5fdb8e03</d2p1:Id>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
        <d2p1:LastName>sample string 5</d2p1:LastName>
        <d2p1:LoginProviders>
          <d2p1:GetLoginProviderResponse>
            <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
            <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
            <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
          </d2p1:GetLoginProviderResponse>
          <d2p1:GetLoginProviderResponse>
            <d2p1:Id>82218280-877b-48ff-868b-826c1371a0b3</d2p1:Id>
            <d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
            <d2p1:ProviderName>sample string 2</d2p1:ProviderName>
            <d2p1:UserId>71708f11-943b-42e3-9285-faca20da9b92</d2p1:UserId>
          </d2p1:GetLoginProviderResponse>
        </d2p1:LoginProviders>
        <d2p1:Roles xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Roles>
        <d2p1:Username>sample string 2</d2p1:Username>
      </d2p1:GetUserResponse>
    </d2p1:Users>
    <d2p1:ZipCode>sample string 5</d2p1:ZipCode>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <IsSuccess>true</IsSuccess>
</ApiResponseOfGetUserGroupResponseWithSubGroupsLgVmlFmJ>