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

# Get a shared lesson item

> Returns shared engagement records for a specific lesson item (e.g. poll responses or video uploads visible to other learners).

Get shared engagement records for a lesson item

**A missing record does not return 404.** This handler reports the failure without a status code, and the error envelope defaults to HTTP `200` — you get `200` with `status: "failed"`. Branch on `status`, not on the HTTP code.



## OpenAPI

````yaml /api-reference/specs/lessons.json get /api/lessons/{id}/shared/{item_uuid}
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/{id}/shared/{item_uuid}:
    get:
      tags:
        - Lessons
      summary: Get a shared lesson item
      description: >-
        Returns shared engagement records for a specific lesson item (e.g. poll
        responses or video uploads visible to other learners).


        Get shared engagement records for a lesson item


        **A missing record does not return 404.** This handler reports the
        failure without a status code, and the error envelope defaults to HTTP
        `200` — you get `200` with `status: "failed"`. Branch on `status`, not
        on the HTTP code.
      operationId: getSharedEngagementRecordsForALessonItem
      parameters:
        - name: item_uuid
          in: path
          required: true
          description: The item_uuid identifier.
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: The id identifier.
          schema:
            type: string
        - name: start_time
          in: query
          description: Unix timestamp filter — only records after this time.
          schema:
            type: integer
        - name: end_time
          in: query
          description: Unix timestamp filter — only records before this time.
          schema:
            type: integer
        - name: con_id
          in: query
          description: Filter to a specific contact's records.
          schema:
            type: string
        - name: limit
          in: query
          description: 'Max results to return. Default: `100` (JSON), `1000` (CSV).'
          schema:
            type: integer
        - name: offset
          in: query
          description: 'Pagination offset. Default: `0`.'
          schema:
            type: integer
        - name: format
          in: query
          description: Pass `csv` to download results as a CSV file.
          schema:
            type: string
        - $ref: '#/components/parameters/teams'
        - name: reviews_count
          in: query
          required: false
          description: How many reviews to include. Defaults to -1 (all).
          schema:
            type: integer
        - name: trigger
          in: query
          required: false
          description: Trigger ID to resolve the shared lesson item against.
          schema:
            type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/SharedEngagementRecord'
              example:
                status: ok
                message: results found
                data:
                  total: 42
                  offset: 0
                  records:
                    - $cid: 64a1b2c3d4e5f6a7b8c9d0e1
                      $name: Jane Doe
                      $timestamp: 1718438400
                      meta: {}
        '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.
    SharedEngagementRecord:
      type: object
      description: >-
        A shared engagement record. Each row carries exactly these keys — this
        endpoint does not return lesson items. Key names carry a literal `$`
        prefix.
      properties:
        $name:
          type: string
          description: Contact's display name.
        $cid:
          type: string
          description: Contact ID.
        $photo:
          type: string
          description: Contact's photo.
        $date:
          type: string
          description: Formatted date of the engagement.
        $timestamp:
          type: integer
          description: Unix timestamp of the engagement.
        points:
          type: number
          description: Points awarded.
        meta:
          type: object
          description: >-
            Engagement payload. Its shape depends on the item type (poll,
            open-ended, video upload and so on) — not verified per type.
  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.