Get a list of persons from the specified list

POST /persons


Description

The method returns a list of persons from the user's specified list (default or indicated). A token is required, see Authorization.


Request format

  • HTTP method: POST
  • URL: /persons
  • Content type: application/json

Authorization

Pass the token in one of two ways:

  • the token: <jwt-token> header — a temporary JWT token obtained with user/login;
  • the token field in the request body — a permanent API token (UUID) from your account.

Without a token the request returns 401 access denied.


Request Body (JSON)

FieldTypeRequiredDescription
tokenstring—Permanent API token (UUID), if the token header is not sent
list_idstring✅Person list ID
limitinteger❌Maximum number of records to return
cursorstring❌Cursor for pagination
thumbsbool❌Return image thumbnails
embeddingsbool❌Return embeddings

Example Request (cURL)

curl -X POST "https://api.neuro-vision.ru/v1/persons" -H "Content-Type: application/json" -H "token: <jwt-token>" -d '{"list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "limit": 10, "cursor": "", "thumbs": true, "embeddings": true}'

Example Answers

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"
}