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

# List Assignments

> List all assignments in the admin's organization with pagination.

Requires admin role. Includes enriched data (user/ship names).
Supports search by user name, email, or ship name via ?search= param.
Search is handled via SQL subqueries in the repository layer.



## OpenAPI

````yaml /openapi.json get /api/v1/learn/assignments
openapi: 3.1.0
info:
  title: Seamind Backend
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/learn/assignments:
    get:
      tags:
        - learn-assignments
      summary: List Assignments
      description: |-
        List all assignments in the admin's organization with pagination.

        Requires admin role. Includes enriched data (user/ship names).
        Supports search by user name, email, or ship name via ?search= param.
        Search is handled via SQL subqueries in the repository layer.
      operationId: list_assignments_api_v1_learn_assignments_get
      parameters:
        - name: ship_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by ship (single UUID or comma-separated UUIDs for OR)
            title: Ship Id
          description: Filter by ship (single UUID or comma-separated UUIDs for OR)
        - name: is_active
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: Filter by active status
            title: Is Active
          description: Filter by active status
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Items per page
            default: 10
            title: Limit
          description: Items per page
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Pagination cursor
            title: Cursor
          description: Pagination cursor
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            description: Search term
            title: Search
          description: Search term
        - name: include_count
          in: query
          required: false
          schema:
            type: boolean
            description: Include total count
            default: false
            title: Include Count
          description: Include total count
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_AssignmentDetailDTO_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PaginatedResponse_AssignmentDetailDTO_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AssignmentDetailDTO'
          type: array
          title: Items
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Nextcursor
        hasMore:
          type: boolean
          title: Hasmore
          default: false
        totalCount:
          anyOf:
            - type: integer
            - type: 'null'
          title: Totalcount
      type: object
      required:
        - items
      title: PaginatedResponse[AssignmentDetailDTO]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AssignmentDetailDTO:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        userId:
          type: string
          format: uuid
          title: Userid
        userName:
          type: string
          title: Username
        userEmail:
          type: string
          title: Useremail
        shipId:
          type: string
          format: uuid
          title: Shipid
        shipName:
          type: string
          title: Shipname
        shipImoNumber:
          anyOf:
            - type: string
            - type: 'null'
          title: Shipimonumber
        role:
          type: string
          title: Role
        startDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Startdate
        endDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Enddate
        isActive:
          type: boolean
          title: Isactive
      type: object
      required:
        - id
        - userId
        - userName
        - userEmail
        - shipId
        - shipName
        - role
        - startDate
        - endDate
        - isActive
      title: AssignmentDetailDTO
      description: Assignment with denormalized user/ship names for API responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````