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

# List users

> List the users of the workspace, whatever their state.

Lists the users of the workspace with their license, role and state. Users are returned whatever their state (active, suspended, gone or deleted). Use the `email` query parameter to look up a single user by email; an unknown email returns an empty list.


## OpenAPI

````yaml GET /v1/users
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/users:
    get:
      description: List the users of the workspace, whatever their state.
      operationId: getV1Users
      parameters:
        - in: query
          name: cursor
          schema:
            type: string
            description: >-
              Paginate the results starting at the cursor returned by a previous
              call. Pages may contain fewer than "limit" results; iterate until
              no nextCursor is returned.
        - in: query
          name: email
          schema:
            type: string
            description: >-
              Return only the user with this email. When provided, cursor and
              limit are ignored. An unknown email returns an empty list.
        - in: query
          name: limit
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
            description: Return at most "limit" results.
      responses:
        '200':
          description: Users were successfully retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      users:
                        type: array
                        items:
                          $ref: '#/components/schemas/ApiWorkspaceUser'
                      pagination:
                        type: object
                        properties:
                          nextCursor:
                            type: string
                    required:
                      - users
                      - pagination
                required:
                  - result
        '400':
          description: Cursor is not valid.
components:
  schemas:
    ApiWorkspaceUser:
      type: object
      properties:
        email:
          type: string
          description: User email.
        id:
          type: string
          description: User identifier, scoped to the workspace.
        license:
          type: string
          enum:
            - None
            - Basic
            - Starter
            - Pro
            - Business
          description: User license.
        name:
          type: string
          description: User full name.
        role:
          type: string
          enum:
            - Owner
            - Admin
            - Creator
            - Guest
            - None
          description: User role in the workspace.
        state:
          type: string
          enum:
            - Active
            - Deleted
            - Gone
            - Suspended
          description: User state in the workspace.
      required:
        - email
        - id
        - license
        - name
        - role
        - state
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````