Sign in

Retrieve Person Group name, userData and recognitionModel. To get person information under this personGroup, use "Get Person Group Persons".

get/persongroups/{personGroupId}

Path parameters

personGroupIdstring required

ID of the container.

Query parameters

returnRecognitionModelboolean

Return 'recognitionModel' or not. The default value is false.

Response

A successful call returns the Person Group's information.

namestring required

User defined name, maximum length is 128.

userDatastring

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

recognitionModel'recognition_01' | 'recognition_02' | 'recognition_03' | 'recognition_04'

The recognition model for the face.

personGroupIdstring required

Changes

Changed in 1 of the 5 revisions of this API.1

  • e1f63ec9983b1See the full diff
    • ○

      api operation id PersonGroup_Get removed and replaced with PersonGroupOperations_GetPersonGroup

      api-operation-id-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog