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

# List company members

> This endpoint allows to list company members.

**Permissions:**
- Admin, SysAdmin, SysDPO, Account Manager: can view all users (optionally filter by company_id)
- Company Admin, Company DPO: can view users from their own company

**Query Parameters:**
- `company_id` (optional): Filter by company (SysAdmin, SysDPO, Account Manager only)
- `group_id` (optional): Filter by group ID (users must be members of the specified group)
- `is_active` (optional): Filter by active status

**Throttling:** 100 requests per minute

It is API Key protected and restricted to users with appropriate permissions.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/users
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Agents
    description: Operations about agents
  - name: Threads
    description: Operations about agents conversation threads
  - name: Tools
    description: Operations about native tools
  - name: Models
    description: Operations about AI models
  - name: MCP
    description: Operations about MCP servers
  - name: Sources
    description: Operations about sources used by agents conversation threads
  - name: Artifacts
    description: Operations about artifacts generated by agents conversation threads
  - name: Agent
    description: >-
      Operations about agents (deprecated). Please use the 'Agents' API
      component instead.
  - name: Files
    description: Operations about files
  - name: Files Processing
    description: Operations about files processing
  - name: Tags
    description: Operations about tags
  - name: Workspaces
    description: Operations about workspaces
  - name: Users
    description: Operations about users
  - name: User Groups
    description: Operations about user groups
  - name: Companies
    description: Operations about companies
  - name: SCIM
    description: Operations about SCIM
paths:
  /api/v3/users:
    get:
      tags:
        - Users
      summary: List company members
      description: >-
        This endpoint allows to list company members.


        **Permissions:**

        - Admin, SysAdmin, SysDPO, Account Manager: can view all users
        (optionally filter by company_id)

        - Company Admin, Company DPO: can view users from their own company


        **Query Parameters:**

        - `company_id` (optional): Filter by company (SysAdmin, SysDPO, Account
        Manager only)

        - `group_id` (optional): Filter by group ID (users must be members of
        the specified group)

        - `is_active` (optional): Filter by active status


        **Throttling:** 100 requests per minute


        It is API Key protected and restricted to users with appropriate
        permissions.
      operationId: api_v3_users_list
      parameters:
        - in: query
          name: company_id
          schema:
            type: integer
          description: Filter by company ID (for admin users only)
        - in: query
          name: group_id
          schema:
            type: integer
          description: Filter by group ID (users must be members of the specified group)
        - in: query
          name: is_active
          schema:
            type: boolean
          description: Filter by active status
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyMemberResponseList'
          description: List of company members accessible to the authenticated user
        '401':
          description: Authentication failed - missing or invalid API key
        '403':
          description: Permission denied - insufficient rights to access company members
        '500':
          description: Internal server error
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedCompanyMemberResponseList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/CompanyMemberResponse'
    CompanyMemberResponse:
      type: object
      properties:
        id:
          type: integer
        username:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        is_active:
          type: boolean
        date_joined:
          type: string
          format: date-time
        account_expiration_date:
          type: string
          format: date-time
        last_login:
          type: string
          format: date-time
        invitation_status:
          type: string
        language:
          type: string
        company:
          $ref: '#/components/schemas/CompanyMemberCompany'
        roles:
          type: array
          items:
            $ref: '#/components/schemas/TenantUserRole'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/CompanyMemberGroups'
      required:
        - account_expiration_date
        - company
        - date_joined
        - email
        - first_name
        - groups
        - id
        - invitation_status
        - is_active
        - language
        - last_login
        - last_name
        - roles
        - username
    CompanyMemberCompany:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    TenantUserRole:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
    CompanyMemberGroups:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        role:
          type: string
        category:
          type: string
        created_at:
          type: string
          format: date-time
      required:
        - category
        - created_at
        - description
        - id
        - name
        - role
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````