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

# List VIP employees

> Returns a paginated page of the caller's VIP list — both the employees Ocean auto-detected from job title and department, and those added manually. `q` matches any of email, full name, job title, department, comment or the adder's name. Rows with no mailbox are real VIPs and are returned last.



## OpenAPI

````yaml get /api/v1/settings/vip_employees
openapi: 3.0.0
info:
  contact: {}
  title: Ocean Security API
  version: 1.0.0
  description: Ocean Security API for threat detection and security metrics
servers:
  - url: https://api.ocean.security
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Threats
    description: Operations for retrieving threat information
  - name: Metrics
    description: Security metrics and analytics endpoints
paths:
  /api/v1/settings/vip_employees:
    get:
      tags:
        - VIP Employees
      summary: List VIP employees
      description: >-
        Returns a paginated page of the caller's VIP list — both the employees
        Ocean auto-detected from job title and department, and those added
        manually. `q` matches any of email, full name, job title, department,
        comment or the adder's name. Rows with no mailbox are real VIPs and are
        returned last.
      parameters:
        - description: Authentication API Key
          in: header
          name: X-Api-Key
          required: true
          schema:
            type: string
        - description: 1-based page index (default 1)
          in: query
          name: page
          schema:
            type: integer
        - description: Page size (default 50, max 200)
          in: query
          name: page_size
          schema:
            type: integer
        - description: >-
            Free-text match across email, name, job title, department, comment
            and adder
          in: query
          name: q
          schema:
            type: string
        - description: 'Sort by date added: asc or desc (default desc)'
          in: query
          name: order
          schema:
            type: string
      responses:
        '200':
          description: Paginated VIP employees
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ocean_api_common.BaseResponse-controllers_settings_vip_ListVipEmployeesResult
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
        '503':
          description: VIP source unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/types.ErrorResponse'
components:
  schemas:
    ocean_api_common.BaseResponse-controllers_settings_vip_ListVipEmployeesResult:
      properties:
        results:
          $ref: '#/components/schemas/controllers_settings_vip.ListVipEmployeesResult'
        status:
          type: integer
      type: object
    types.ErrorResponse:
      properties:
        error:
          type: string
      type: object
    controllers_settings_vip.ListVipEmployeesResult:
      properties:
        items:
          items:
            $ref: '#/components/schemas/controllers_settings_vip.VipEmployee'
          type: array
        page:
          type: integer
        page_size:
          type: integer
        total:
          type: integer
      type: object
    controllers_settings_vip.VipEmployee:
      properties:
        added_by:
          type: string
        comment:
          type: string
        date_added:
          type: string
        department:
          type: string
        email:
          type: string
        full_name:
          type: string
        job_title:
          type: string
        source:
          type: string
        updated_at:
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key for authentication

````