---
title: "GET /largepersongroups"
method: GET
path: "/largepersongroups"
---

# GET /largepersongroups

`GET /largepersongroups`

List all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.<br />
* Large person groups are stored in alphabetical order of largePersonGroupId.
* "start" parameter (string, optional) is a user-provided largePersonGroupId 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 returned entry’s Id of the current call.
<br />
For example, total 5 large 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".

## Query parameters

- `start` string
- `top` integer
- `returnRecognitionModel` boolean

## Response `200`

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

- LargePersonGroup[] — An array of large person groups.
  - `largePersonGroupId` string, required — LargePersonGroupId of the target large person groups
  - `name` string, required — User defined name, maximum length is 128.
  - `userData` string — User specified data. Length should not exceed 16KB.
  - `recognitionModel` 'recognition_01' | 'recognition_02' | 'recognition_03' | 'recognition_04' — Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/azure/apis/cognitiveservices-face.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-face/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-face/versions/8a19b734b92a/schema)