UserGroup

Gets the user list for a user group.

Returns the users in the group with availability details. This endpoint is restricted to the group creator.

get/v1/usergroup/{userGroupID}/list

Request

  • Base URL: https://api.actionstreamer.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.actionstreamer.com/v1/usergroup/{userGroupID}/list
  • Auth: none declared

Path parameters

userGroupIDinteger required
Example:1

The ID of the user group whose users should be returned.

Response

Success

keyinteger nullable
emailAddressstring nullable
firstNamestring nullable
lastNamestring nullable
descriptionstring nullable
availabilitystring nullable
timeZonestring nullable

Example response

[
  {
    "key": 101,
    "emailAddress": "testuser@actionstreamer.com",
    "firstName": "Test",
    "lastName": "User",
    "description": "Example description",
    "availability": "Available",
    "timeZone": "America/New_York"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.