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

> This endpoint allows users to list companies based on their permissions.

Access levels:
- SysAdmin/Account Manager/DPO Admin: Can view all companies
- Company Admin: Can view their own company only
- Company DPO: Read-only access to their own company
- User: No access

Supports pagination and search functionality.



## OpenAPI

````yaml /api-reference/openapi-v3.yaml get /api/v3/companies
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/companies:
    get:
      tags:
        - Companies
      summary: List companies
      description: |-
        This endpoint allows users to list companies based on their permissions.

        Access levels:
        - SysAdmin/Account Manager/DPO Admin: Can view all companies
        - Company Admin: Can view their own company only
        - Company DPO: Read-only access to their own company
        - User: No access

        Supports pagination and search functionality.
      operationId: api_v3_companies_list
      parameters:
        - in: query
          name: page
          schema:
            type: integer
          description: 'Page number (default: 1)'
        - in: query
          name: search
          schema:
            type: string
          description: Filter by company name (case-insensitive)
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyListResponseList'
          description: >-
            List of companies with DRF pagination (count, next, previous,
            results)
        '403':
          description: Insufficient permissions
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedCompanyListResponseList:
      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/CompanyListResponse'
    CompanyListResponse:
      type: object
      description: Serializer for listing companies
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: The name of the company registered in the instance.
          maxLength: 255
        dpo_email:
          type: string
          format: email
          nullable: true
          description: Contact email displayed in user profiles for data privacy inquiries.
          maxLength: 254
        max_users:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          description: Maximum allowed active users for this company license.
        created_at:
          type: string
          format: date-time
          readOnly: true
        login_method:
          allOf:
            - $ref: '#/components/schemas/LoginMethodEnum'
          description: |-
            Authentication method(s) allowed for users in this company.

            * `password` - Password
            * `sso` - Single Sign On
            * `ldap` - LDAP
      required:
        - created_at
        - id
        - name
    LoginMethodEnum:
      enum:
        - password
        - sso
        - ldap
      type: string
      description: |-
        * `password` - Password
        * `sso` - Single Sign On
        * `ldap` - LDAP
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````