Sign in

v5

latestSwagger 2.02026-07-136680294.1 KB

List all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.

Persons are stored in alphabetical order of personId created in "Create Person Group Person".

    • "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
    • "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.

[!TIP]

  • For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
    • "start=&top=" will return all 5 items.
    • "start=&top=2" will return "itemId1", "itemId2".
    • "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".
get/persongroups/{personGroupId}/persons

Path parameters

personGroupIdstring required

ID of the container.

Query parameters

startstring

List resources greater than the "start". It contains no more than 64 characters. Default is empty.

topinteger

The number of items to list, ranging in [1, 1000]. Default is 1000.

Response

A successful call returns an array of person information that belong to the Person Group.

personIdstring uuid required

Universally Unique Identifier

namestring required

User defined name, maximum length is 128.

userDatastring

Optional user defined data. Length should not exceed 16K.

persistedFaceIdsAzureCoreUuid[]

Face ids of registered faces in the person.