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

# GET /largepersongroups

`GET /largepersongroups`

List all existing large person groups’s 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 retuned 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.
  - `name` string — User defined name, maximum length is 128.
  - `userData` string — User specified data. Length should not exceed 16KB.

## Other responses

- `default` — Error response.

## Changes

- **2019-03-25** `37a7900a44ee` — 1 info
  - added the new optional `query` request parameter `returnRecognitionModel`
- **2018-08-01** `dcdc115e9ae8` — 1 info
  - endpoint added
- **2017-12-28** `e67414f9aeba` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/azure/apis/cognitiveservices-face/changes/largepersongroups/get.md)

---

[API](https://skmtc.dev/azure/apis/cognitiveservices-face.md) · [All operations](https://skmtc.dev/azure/apis/cognitiveservices-face/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/cognitiveservices-face/revisions/37a7900a44ee/schema)
