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

# List employees

> Returns employees for the API key company. The response is sorted by firstName, lastName, and id, and capped at 1000 employees.

Required API key scope: `read`.



## OpenAPI

````yaml /openapi/public-api-v1.json get /v1/employees
openapi: 3.1.0
info:
  title: YoLead Public API
  version: 1.0.0
  description: >-
    Public REST API for YoLead integrations. Only endpoints mounted under /v1
    are included. Management endpoints used by the YoLead UI, including
    /integrations/*, are intentionally excluded.
servers:
  - url: https://api.yo-lead.com
    description: Production
security:
  - YoLeadPublicKey: []
    YoLeadTimestamp: []
    YoLeadSignature: []
tags:
  - name: Employees
    description: Employee data available to integrations.
  - name: Embed
    description: Iframe session creation for embedding YoLead UI.
  - name: Tickets
    description: Ticket history and status operations.
paths:
  /v1/employees:
    get:
      tags:
        - Employees
      summary: List employees
      description: >-
        Returns employees for the API key company. The response is sorted by
        firstName, lastName, and id, and capped at 1000 employees.


        Required API key scope: `read`.
      operationId: listEmployees
      responses:
        '200':
          description: Employees list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeesResponse'
              example:
                data:
                  - id: 64f000000000000000000001
                    firstName: Alex
                    lastName: Smith
                    channels:
                      - 64f000000000000000000010
                    position: Operator
                    access: default
                    status: active
                    createdAt: '2026-05-08T12:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ListEmployeesResponse:
      type: object
      additionalProperties: false
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiEmployee'
    PublicApiEmployee:
      type: object
      additionalProperties: false
      required:
        - id
        - channels
        - position
        - access
        - status
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        firstName:
          type: string
          example: Alex
        lastName:
          type: string
          example: Smith
        channels:
          type: array
          items:
            $ref: '#/components/schemas/ObjectId'
        position:
          type: string
          example: Operator
        access:
          type: string
          enum:
            - default
            - manager
            - admin
            - owner
        status:
          type: string
          enum:
            - invited
            - active
            - inactive
        createdAt:
          $ref: '#/components/schemas/IsoDateTime'
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - code
        - message
      properties:
        code:
          type: integer
          example: 40001
        message:
          type: string
          example: Validation error
    ObjectId:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: MongoDB ObjectId represented as a 24-character hexadecimal string.
      example: 64f000000000000000000001
    IsoDateTime:
      type: string
      format: date-time
      description: ISO 8601 date-time string.
      example: '2026-05-08T12:00:00.000Z'
  responses:
    Unauthorized:
      description: Invalid API credentials, stale timestamp, or invalid request signature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 40121
            message: Invalid API credentials
    Forbidden:
      description: API key scope is not sufficient for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 40361
            message: API key scope is not sufficient
    InternalServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 50001
            message: Internal server error
  securitySchemes:
    YoLeadPublicKey:
      type: apiKey
      in: header
      name: X-YoLead-Key
      description: Public API key generated in the YoLead UI.
    YoLeadTimestamp:
      type: apiKey
      in: header
      name: X-YoLead-Timestamp
      description: >-
        Unix timestamp in milliseconds. Requests must be signed within a
        5-minute window.
    YoLeadSignature:
      type: apiKey
      in: header
      name: X-YoLead-Signature
      description: >-
        Hex HMAC-SHA256 signature over `<timestamp>.<raw_body>` using the API
        secret.

````