> ## 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.

# Get list of faces

> Retrieve a list of all faces contained within a specific collection

This API endpoint allows you to retrieve a list of all faces contained within a specific collection. You can use pagination and search functionality to efficiently manage large collections of facial data.

## Request

### Headers

<ParamField header="x-api-key" type="string">
  The API key used for authentication and access control. This header parameter is required for authorization.
</ParamField>

### Query Parameters

<ParamField header="collectionId" type="string" required>
  Unique identifier of the collection where the face will be added.
</ParamField>

<ParamField header="page" type="string" required>
  Page number for pagination. Returns 50 pieces of data per iteration.
</ParamField>

<ParamField header="term" type="string">
  Retrieves a list of faceIds containing a specific string. (Must be at least 5 characters long)
</ParamField>

## Response

### Success Response (200)

<ResponseField name="message" type="string">
  A success or error message indicating the result
</ResponseField>

<ResponseField name="result" type="array">
  Array of face objects containing:

  **collection\_id**: Unique identifier of the face collection

  **face\_id**: Unique identifier for the face in the collection

  **user\_name**: Name of the user associated with the face

  **create\_time**: Timestamp when the face was added

  **meta\_face\_id**: A metadata identifier for the face
</ResponseField>

<ResponseField name="totalCount" type="string">
  Represents the total number of faces found that match the search criteria. In this example, only one face is found, but this value could be higher if more matches are detected.
</ResponseField>

### Error Responses

#### Bad Request (400)

<ResponseField name="errorCode" type="number">
  Identifies the specific error for troubleshooting:

  * 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
</ResponseField>

<ResponseField name="message" type="string">
  Briefly describes the error. Please refer to the error code for details.
</ResponseField>

#### Forbidden (403)

<ResponseField name="errorCode" type="number">
  Identifies the specific error for troubleshooting:

  * 6039: API Key is required
  * 6040: Access Denied: API Key is unavailable
</ResponseField>

<ResponseField name="message" type="string">
  Briefly describes the error. Please refer to the error code for details.
</ResponseField>


## 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

````