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

# List users

> Retrieve existing users.



## OpenAPI

````yaml get /v1/users
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: List users
      description: Retrieve existing users.
      operationId: listUsers
      parameters:
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            maximum: 100
            default: 50
          required: false
          name: take
          in: query
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: skip
          in: query
        - schema:
            type: string
          required: false
          name: first_name
          in: query
        - schema:
            type: string
          required: false
          name: first_name__not
          in: query
        - schema:
            type: string
          required: false
          name: first_name__isNull
          in: query
        - schema:
            type: string
          required: false
          name: first_name__isNotNull
          in: query
        - schema:
            type: string
          required: false
          name: first_name__equals
          in: query
        - schema:
            type: string
          required: false
          name: first_name__contains
          in: query
        - schema:
            type: string
          required: false
          name: first_name__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: first_name__endWith
          in: query
        - schema:
            type: string
          required: false
          name: last_name
          in: query
        - schema:
            type: string
          required: false
          name: last_name__not
          in: query
        - schema:
            type: string
          required: false
          name: last_name__isNull
          in: query
        - schema:
            type: string
          required: false
          name: last_name__isNotNull
          in: query
        - schema:
            type: string
          required: false
          name: last_name__equals
          in: query
        - schema:
            type: string
          required: false
          name: last_name__contains
          in: query
        - schema:
            type: string
          required: false
          name: last_name__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: last_name__endWith
          in: query
        - schema:
            type: string
          required: false
          name: email
          in: query
        - schema:
            type: string
          required: false
          name: email__not
          in: query
        - schema:
            type: string
          required: false
          name: email__isNull
          in: query
        - schema:
            type: string
          required: false
          name: email__isNotNull
          in: query
        - schema:
            type: string
          required: false
          name: email__equals
          in: query
        - schema:
            type: string
          required: false
          name: email__contains
          in: query
        - schema:
            type: string
          required: false
          name: email__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: email__endWith
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUser'
      security:
        - bearer: []
components:
  schemas:
    PaginatedUser:
      type: object
      properties:
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total of existing items.
              example: 1
            taken:
              type: number
              description: Number of items returned.
              example: 1
            skipped:
              type: number
              description: Number of items skipped.
              example: 0
          required:
            - total
            - taken
            - skipped
        data:
          type: array
          items:
            $ref: '#/components/schemas/User'
          description: List of User.
      required:
        - meta
        - data
    User:
      type: object
      properties:
        id:
          type: string
          description: User ID.
          example: usr_DKL4Xcb5VSa8CQ
        email:
          type: string
          format: email
          description: User email address.
          example: john@example.com
        first_name:
          type:
            - string
            - 'null'
          description: User first name.
          example: John
        last_name:
          type:
            - string
            - 'null'
          description: User last name.
          example: Doe
        picture_url:
          type:
            - string
            - 'null'
          format: uri
          description: User profile picture URL.
          example: null
        role_id:
          type:
            - string
            - 'null'
          description: ID of the role assigned to the user.
          example: rol_DKL4Xcb5VSa8CQ
        is_account_owner:
          type: boolean
          description: Whether the user is the account owner.
          example: false
      required:
        - id
        - email
        - first_name
        - last_name
        - picture_url
        - role_id
        - is_account_owner
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````