Sign in

List person groups’s personGroupId, name, userData and recognitionModel.<br />

  • Person groups are stored in alphabetical order of personGroupId.
  • "start" parameter (string, optional) is a user-provided personGroupId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last retuned entry’s Id of the current call. <br />

For example, total 5 person groups: "group1", ..., "group5". <br /> "start=&top=" will return all 5 groups. <br /> "start=&top=2" will return "group1", "group2". <br /> "start=group2&top=3" will return "group3", "group4", "group5".

get/persongroups

Query parameters

startstring

List person groups from the least personGroupId greater than the "start".

topinteger

The number of person groups to list.

returnRecognitionModelboolean

A value indicating whether the operation should return 'recognitionModel' in response.

Response

A successful call returns an array of person groups and their information.

namestring

User defined name, maximum length is 128.

userDatastring

User specified data. Length should not exceed 16KB.

Changes