GET api/userGroups/userGroup/{userGroupId}/getMembers?page={page}&recordsPerPage={recordsPerPage}&query={query}

Search group members.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userGroupId

A user group id.

 integer

Required
page

Page number.

 integer

Required
recordsPerPage

Records per page.

 integer

Required
query

Query, default is an empty string.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

UserCollection
NameDescriptionTypeAdditional information
Users

Collection of users

 Collection of User

None.
Pagination

Pagination for users

 Pagination

None.

Response Formats

application/json, text/json

Sample: 
{
  "Users": [
    {
      "UserId": 1,
      "OrgId": 2,
      "Username": "sample string 3",
      "Firstname": "sample string 4",
      "Lastname": "sample string 5",
      "IsArchived": true,
      "Email": "sample string 7",
      "DateOfBirth": "2024-09-21T02:50:47.3153329+00:00",
      "ProfilePhotoUrl": "sample string 9",
      "DateCreated": "2024-09-21T02:50:47.3153329+00:00",
      "LastActivity": "2024-09-21T02:50:47.3153329+00:00",
      "IsStaff": true,
      "AdvancedID": "sample string 13"
    },
    {
      "UserId": 1,
      "OrgId": 2,
      "Username": "sample string 3",
      "Firstname": "sample string 4",
      "Lastname": "sample string 5",
      "IsArchived": true,
      "Email": "sample string 7",
      "DateOfBirth": "2024-09-21T02:50:47.3153329+00:00",
      "ProfilePhotoUrl": "sample string 9",
      "DateCreated": "2024-09-21T02:50:47.3153329+00:00",
      "LastActivity": "2024-09-21T02:50:47.3153329+00:00",
      "IsStaff": true,
      "AdvancedID": "sample string 13"
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "TotalRecords": 2,
    "RecordsPerPage": 3
  }
}

application/xml, text/xml

Sample: 
<UserCollection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Users>
    <User>
      <UserId>1</UserId>
      <OrgId>2</OrgId>
      <Username>sample string 3</Username>
      <Firstname>sample string 4</Firstname>
      <Lastname>sample string 5</Lastname>
      <IsArchived>true</IsArchived>
      <Email>sample string 7</Email>
      <DateOfBirth>2024-09-21T02:50:47.3153329+00:00</DateOfBirth>
      <ProfilePhotoUrl>sample string 9</ProfilePhotoUrl>
      <DateCreated>2024-09-21T02:50:47.3153329+00:00</DateCreated>
      <LastActivity>2024-09-21T02:50:47.3153329+00:00</LastActivity>
      <IsStaff>true</IsStaff>
      <AdvancedID>sample string 13</AdvancedID>
    </User>
    <User>
      <UserId>1</UserId>
      <OrgId>2</OrgId>
      <Username>sample string 3</Username>
      <Firstname>sample string 4</Firstname>
      <Lastname>sample string 5</Lastname>
      <IsArchived>true</IsArchived>
      <Email>sample string 7</Email>
      <DateOfBirth>2024-09-21T02:50:47.3153329+00:00</DateOfBirth>
      <ProfilePhotoUrl>sample string 9</ProfilePhotoUrl>
      <DateCreated>2024-09-21T02:50:47.3153329+00:00</DateCreated>
      <LastActivity>2024-09-21T02:50:47.3153329+00:00</LastActivity>
      <IsStaff>true</IsStaff>
      <AdvancedID>sample string 13</AdvancedID>
    </User>
  </Users>
  <Pagination>
    <CurrentPage>1</CurrentPage>
    <TotalRecords>2</TotalRecords>
    <RecordsPerPage>3</RecordsPerPage>
  </Pagination>
</UserCollection>