> ## Documentation Index
> Fetch the complete documentation index at: https://docs.recallrai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Users

> List all users in your project with pagination and filtering.

Retrieve all registered users with support for metadata-based filtering and partial user ID search.
Results include user activity timestamps and custom metadata.

**Query Parameters:**
- `offset` (int): Number of records to skip for pagination. Default: 0
- `limit` (int): Maximum records to return. Range: 1-100. Default: 10
- `metadata_filter` (str): JSON string filter for user metadata (supports nested JSON matching)
- `partial_user_id` (str): Partial user ID to search for (case-insensitive)

**Returns:**
- `users` (List[UserInfo]): List of user objects
- `total` (int): Total number of users matching the filters
- `has_more` (bool): Whether more users are available beyond the current page



## OpenAPI

````yaml https://api.recallrai.com/api/openapi.json get /api/v1/users
openapi: 3.1.0
info:
  title: api-backend
  description: This powers the Recallr AI API Backend
  version: 0.1.0
servers:
  - url: https://api.recallrai.com
    description: Production server
security: []
paths:
  /api/v1/users:
    get:
      tags:
        - Users
      summary: List Users
      description: >-
        List all users in your project with pagination and filtering.


        Retrieve all registered users with support for metadata-based filtering
        and partial user ID search.

        Results include user activity timestamps and custom metadata.


        **Query Parameters:**

        - `offset` (int): Number of records to skip for pagination. Default: 0

        - `limit` (int): Maximum records to return. Range: 1-100. Default: 10

        - `metadata_filter` (str): JSON string filter for user metadata
        (supports nested JSON matching)

        - `partial_user_id` (str): Partial user ID to search for
        (case-insensitive)


        **Returns:**

        - `users` (List[UserInfo]): List of user objects

        - `total` (int): Total number of users matching the filters

        - `has_more` (bool): Whether more users are available beyond the current
        page
      operationId: list_users_api_v1_users_get
      parameters:
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            title: The offset of the users to get
            default: 0
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            title: The limit of the users to get
            default: 10
        - name: metadata_filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: JSON string filter for user metadata
        - name: partial_user_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Partial user ID to search for
        - name: X-Recallr-Project-Id
          in: header
          required: true
          schema:
            type: string
            format: uuid
            title: X-Recallr-Project-Id
        - name: X-Recallr-Api-Key
          in: header
          required: true
          schema:
            type: string
            title: X-Recallr-Api-Key
      responses:
        '200':
          description: Users listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
        '401':
          description: Authentication required
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal server error
components:
  schemas:
    ListUsersResponse:
      properties:
        users:
          items:
            $ref: '#/components/schemas/UserInfo'
          type: array
          title: Users
        total:
          type: integer
          title: Total
        has_more:
          type: boolean
          title: Has More
      type: object
      required:
        - users
        - total
        - has_more
      title: ListUsersResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserInfo:
      properties:
        custom_user_id:
          type: string
          title: Custom User Id
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
        merge_conflict_enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Merge Conflict Enabled
        created_at:
          type: string
          format: date-time
          title: Created At
        last_active_at:
          type: string
          format: date-time
          title: Last Active At
      type: object
      required:
        - custom_user_id
        - metadata
        - merge_conflict_enabled
        - created_at
        - last_active_at
      title: UserInfo
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````