Guides

πŸ” [GET] Get List of Faces

Gets a list of the Face ID contained within the collection.

Type : GET

Input Data (Qurey String):

KeyFormatRequiredDescription
collectionIdstringOThe unique ID of the collection for which you want to get a list of faces.
pagenumberOPage number for pagination. Returns 50 pieces of data per iteration.
termstringXRetrieves a list of faceIds containing a specific string. Must be at least 5 characters long.
Submit when a specific faceId is retrieved.

Output Data:

KeyFormatDescription
messagestringThe success or error message.
resultarrayAn array of the Faces objects retrieved.
result[i].collection_idstringThe unique ID of the collection containing each face.
result[i].face_idstringThe unique ID of each face submission.
result[i].meta_face_idstringThe unique ID of each face.
result[i].user_namestringThe username submitted for each face.
result[i].create_timestringThe time each face was submitted.
totalCountnumberThe total number of faces in the collection.

Error (403)

Error codeError messageDescription
6039API Key is required.Missing API Key: x-api-key is missing in header
6040Access Denied: API Key is unavailable.Unregistered API Key: Access restriction

Error (400)

Error codeError messageDescription
6024CollectionId is required.CollectionId is missing
6025The term length must be longer than 5Term string is less than 5 characters long
6026Page number is required.Page is missing
6027Cannot find collection info.Collection information does not exist
6028This collection is unavailable.The collection has already been deleted
6029Fail to get Face listUnspecified errors
  • Request Headers
x-api-key : "string"
  • Request Data
collectionId : "string"
page : number
term : "string"
  • Response
{
    "message": "success",
    "result": [
        {
            "collection_id": "string",
            "face_id": "string",
            "user_name": "string",
            "create_time": "string",
            "meta_face_id": "string"
        }
    ],
    "totalCount": number
}
  • Error Response
{
   errorCode: number,
   message: "string"
}