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

# Search lessons

> Search lessons by keyword.

Search lessons by keyword (full-text + has:/event: prefixes)

**Permission:** requires `lessons`.

**Response shape:** `data` is a **flat array** of records. This endpoint ignores `page` — the full matching set comes back in one response.



## OpenAPI

````yaml /api-reference/specs/lessons.json get /api/lessons/search
openapi: 3.1.0
info:
  title: ConveYour API — Lessons
  description: Retrieve, search, and manage lessons and lesson folders.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Lessons
    description: Retrieve, search, and manage lessons and lesson folders.
paths:
  /api/lessons/search:
    get:
      tags:
        - Lessons
      summary: Search lessons
      description: >-
        Search lessons by keyword.


        Search lessons by keyword (full-text + has:/event: prefixes)


        **Permission:** requires `lessons`.


        **Response shape:** `data` is a **flat array** of records. This endpoint
        ignores `page` — the full matching set comes back in one response.
      operationId: searchLessonsByKeywordFullTextHasEventPrefixes
      parameters:
        - name: query
          in: query
          description: >-
            Search term. Uses full-text search. Supports special prefixes:
            `has:<item_type>` to filter by item type (e.g. `has:video`),
            `event:<name>` to filter by engagement event.
          schema:
            type: string
          required: true
        - name: folder_id
          in: query
          description: Restrict search to a specific folder.
          schema:
            type: string
        - name: schema
          in: query
          description: 'Schema detail level. Default: `full`.'
          schema:
            type: string
        - name: deleted
          in: query
          description: Pass `1` to include soft-deleted lessons.
          schema:
            type: boolean
        - $ref: '#/components/parameters/teams'
        - name: item_types
          in: query
          description: >-
            Restrict results to lessons containing these item types. Repeat the
            key for multiple values.
          required: false
          schema:
            type: array
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/LessonSearchResult'
              example:
                status: ok
                message: Lessons found
                data:
                  - id: 64a1b2c3d4e5f6a7b8c9d0e1
                    name: Onboarding Day 1
                    tags:
                      - onboarding
                    relevance: 1.2
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    LessonSearchResult:
      allOf:
        - $ref: '#/components/schemas/Lesson'
        - type: object
          description: Search adds a relevance score to each record.
          properties:
            relevance:
              type: number
              description: Text-search relevance score. Added by the search endpoint only.
    Lesson:
      type: object
      description: A lesson.
      properties:
        id:
          type: string
          description: Lesson ID.
        uuid:
          type: string
          description: Stable identifier. Required on create.
        name:
          type: string
          description: Lesson name.
        title:
          type: string
          description: Display title.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: Author.
        banner_img:
          type: string
          description: Banner image.
        icon:
          type: string
          description: Icon.
        items:
          type: array
          description: >-
            Lesson items. Each item's shape depends on its type — see the lesson
            item templates.
        items_count:
          type: integer
          description: Number of items.
        length:
          type: integer
          description: Estimated length.
        folder_id:
          type: string
          description: Containing folder.
        order:
          type: number
          description: Sort order.
        order_updated_at:
          type: integer
          description: When the order last changed.
        teams:
          type: array
          description: Teams the lesson is scoped to.
        deleted_at:
          type: integer
          description: Soft-delete timestamp.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
      required:
        - uuid
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.