Get a list of persons from the specified list

Description

The method returns a list of persons from the specified user list (default or selected). JWT token in the header is required for access.

Request format

HTTP method: POST
URL: /persons
Content-Type: application/json
Authorization: required

Request parameters

Parameter	Type	Where passed	Required	Description
token	string	Header	✅	User JWT token

Request body (JSON)

Field	Type	Required	Description
token	string	✅	User JWT token
list_id	string	✅	Identifier of the person list
limit	integer	❌	Maximum number of returned records
cursor	string	❌	Cursor for pagination
thumbs	bool	❌	Whether to return image thumbnails
embeddings	bool	❌	Whether to return embeddings

Example request (cURL)

curl -X POST "https://api.enface.ai/persons" 
  -H "Content-Type: application/json" 
  -H "Authorization: Bearer jwt.temporary.token" 
  -d '{
    "token": "jwt.temporary.token",
    "list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "limit": 10,
    "cursor": "",
    "thumbs": true,
    "embeddings": true
  }'

Response examples

Success (200 OK)

{
  "status": "ok"
}

Error (400 Bad Request)

{
  "message": "invalid schema",
  "status": "error"
}

Error (401 Unauthorized)

{
  "message": "access denied",
  "status": "error"
}

Error (404 Not Found)

{
  "message": "item with this id does not found",
  "status": "error"
}