GET api/v1/informapp/users/{BusinessGroupId}?PageNumber={PageNumber}&PageSize={PageSize}

List users

Request Information

URI Parameters

NameDescriptionTypeAdditional information
BusinessGroupId

Business group id

 universally unique identifier

Required
PageNumber

Page number

 integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647
PageSize

Number of records per page

 integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of users

ListInformAppUserV1Response
NameDescriptionTypeAdditional information
Users

List of users

 Collection of ListInformAppUserV1ResponseUser

None.
Total

Total number of records matching the request

 integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample: 
{
  "Users": [
    {
      "UserId": "58e213fcf1396d37ce86bc1a",
      "AppUserId": "62aa9a2c-2110-4d85-8699-4936a8efb997",
      "Email": "example@email"
    },
    {
      "UserId": "58e213fcf1396d37ce86bc1a",
      "AppUserId": "62aa9a2c-2110-4d85-8699-4936a8efb997",
      "Email": "example@email"
    }
  ],
  "Total": 42
}