🔍 [GET] Get List of Faces

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

Type : GET

Endpoint: https://face.argosidentity.com/faces

Input Data (Qurey String):

Key	Format	Required	Description
collectionId	string	O	The unique ID of the collection for which you want to get a list of faces.
page	number	O	Page number for pagination. Returns 50 pieces of data per iteration.
term	string	X	Retrieves a list of faceIds containing a specific string. Must be at least 5 characters long. Submit when a specific faceId is retrieved.

Output Data:

Key	Format	Description
message	string	The success or error message.
result	array	An array of the Faces objects retrieved.
result[i].collection_id	string	The unique ID of the collection containing each face.
result[i].face_id	string	The unique ID of each face submission.
result[i].meta_face_id	string	The unique ID of each face.
result[i].user_name	string	The username submitted for each face.
result[i].create_time	string	The time each face was submitted.
totalCount	number	The total number of faces in the collection.

Error (403)

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

Error (400)

Error code	Error message	Description
6024	CollectionId is required.	CollectionId is missing
6025	The term length must be longer than 5	Term string is less than 5 characters long
6026	Page number is required.	Page is missing
6027	Cannot find collection info.	Collection information does not exist
6028	This collection is unavailable.	The collection has already been deleted
6029	Fail to get Face list	Unspecified 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"
}