# Query Face List

# Description

This API queries the list of all existing face name entries.

# Request URL

https://api-sgp.yljz.com/finauth/search/group/list_cursor

# Calling Method

POST — Note: Use form-data format for the request.

# Request Parameters

Required?	Field	Type	Description
Required	sign	String	The client signature for calling this API. For how to generate the signature, see the Authentication Guide.
Required	sign_version	String	Signature algorithm version. Pass: hmac_sha1
Required	group_id	String	User-defined face library identifier.
Optional	cursor	String	The starting cursor. When provided, the query returns N entries downward from the current cursor. If not provided, the system defaults to querying from the first entry of the face library.
Optional	limit	Int	Limit on the number of items returned. Default: 100. Maximum: 1000.

# Response Fields

The API returns a JSON string.

Field	Type	Description
request_id	String	A unique string to distinguish each request.
time_used	Int	Total time consumed by the request in milliseconds.
face_tokens	Array	Array of face_token entries. Note: If there is no face_token in the face library, an empty array is returned.
-- face_token	string	Unique face token.
-- user_id	string	User ID.
-- user_data	string	User information.
-- add_time	string	Add time in milliseconds timestamp.
next_cursor	string	Cursor for the next page.
has_more	string	If it returns false, all entries have been retrieved and no further querying is needed.
error	String	Returned only when the request fails. See the error section below for details. Otherwise this field does not exist.

# Example: success response

{
 "request_id": "1783655190,12493042-a443-482d-adaf-1bc12ef1450e",
 "time_used": 178,
 "face_tokens": [
 {
 "face_token": "75932a4a4b090b7c0a87b9452de2e0ff",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783653968086
 },
 {
 "face_token": "6e1f617325fef1c5ca1e538beba3c59a",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654676716
 },
 {
 "face_token": "bfff09553f3700a1aadeea91d1d92ac5",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654692663
 },
 {
 "face_token": "d424506e339748c7f23b15d75cfe3de1",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654696705
 },
 {
 "face_token": "1e172d662d97cfb2672ec186cd213b66",
 "user_id": "user_01",
 "user_data": "Test user",
 "add_time": 1783654715062
 }
 ],
 "next_cursor": "",
 "has_more": false
}

# Example: error response

{
 "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
 "time_used": 15,
 "error": "INVALID_GROUP_ID"
}

---