> ## Documentation Index
> Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Obtener lista de rostros
> Recupere una lista de todos los rostros contenidos dentro de una colección específica
Este endpoint de API le permite recuperar una lista de todos los rostros contenidos dentro de una colección específica. Puede usar la paginación y la funcionalidad de búsqueda para gestionar eficientemente grandes colecciones de datos faciales.
## Solicitud
### Headers
La clave API utilizada para autenticación y control de acceso. Este parámetro de encabezado es requerido para autorización.
### Parámetros de Consulta
Identificador único de la colección donde se agregará el rostro.
Número de página para paginación. Devuelve 50 registros por iteración.
Recupera una lista de faceIds que contienen una cadena específica. (Debe tener al menos 5 caracteres de longitud)
## Respuesta
### Respuesta Exitosa (200)
Un mensaje de éxito o error que indica el resultado.
Array de objetos de rostros que contiene:
**collection\_id**: Identificador único de la colección de rostros
**face\_id**: Identificador único del rostro en la colección
**user\_name**: Nombre del usuario asociado al rostro
**create\_time**: Marca de tiempo de cuando se agregó el rostro
**meta\_face\_id**: Un identificador de metadatos para el rostro
Representa el número total de rostros encontrados que coinciden con los criterios de búsqueda. En este ejemplo, solo se encuentra un rostro, pero este valor podría ser mayor si se detectan más coincidencias.
### Respuestas de Error
#### Bad Request (400)
Identifica el error específico para resolución de problemas:
* 6024: CollectionId is required
* 6025: Term string is less than 5 characters long
* 6026: Page is missing
* 6027: Collection information does not exist
* 6028: This collection is unavailable
* 6029: Fail to get Face list
Describe brevemente el error. Consulte el código de error para más detalles.
#### Forbidden (403)
Identifica el error específico para resolución de problemas:
* 6039: API Key is required
* 6040: Access Denied: API Key is unavailable
Describe brevemente el error. Consulte el código de error para más detalles.
## OpenAPI
````yaml GET /faces
openapi: 3.1.0
info:
title: Face ID API
description: >-
API for facial recognition and identity verification using Face ID
technology
version: 1.0.0
servers:
- url: https://face.argosidentity.com
description: Production server
security: []
paths:
/faces:
get:
tags:
- Face ID
summary: Get list of faces in collection
description: Retrieve a list of all faces contained within a specific collection
operationId: getFaces
parameters:
- name: collectionId
in: query
required: true
schema:
type: string
description: Unique identifier of the collection
- name: page
in: query
required: true
schema:
type: string
description: Page number for pagination. Returns 50 pieces of data per iteration
- name: term
in: query
required: false
schema:
type: string
description: >-
Retrieves a list of faceIds containing a specific string. (Must be
at least 5 characters long)
responses:
'200':
description: List of faces retrieved successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Success message
example: Faces retrieved successfully
result:
type: array
items:
type: object
properties:
collection_id:
type: string
description: Unique identifier of the face collection
face_id:
type: string
description: Unique identifier for the face in the collection
user_name:
type: string
description: Name of the user associated with the face
create_time:
type: string
description: Timestamp when the face was added
meta_face_id:
type: string
description: A metadata identifier for the face
totalCount:
type: string
description: Total number of faces found that match the search criteria
'400':
description: Bad request - Invalid parameters
content:
application/json:
schema:
type: object
properties:
errorCode:
type: number
description: Error code
enum:
- 6024
- 6025
- 6026
- 6027
- 6028
- 6029
message:
type: string
description: Error message
'403':
description: Forbidden - Authentication required
content:
application/json:
schema:
type: object
properties:
errorCode:
type: number
description: Error code
enum:
- 6039
- 6040
message:
type: string
description: Error message
security:
- ApiKeyAuth: []
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
````