---
title: "PaginatedProductsResponse"
url: "https://developers.zinnia.com/apis/product-service/versions/22f4da0f-1e2d-480a-b682-ea9a0819b47f/schemas/PaginatedProductsResponse"
---

> Full API specification: https://developers.zinnia.com/apis/product-service/versions/22f4da0f-1e2d-480a-b682-ea9a0819b47f.md

# PaginatedProductsResponse

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Zinnia Product Service
  version: 0.1.0
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    ProductV2Model:
      type: object
      properties:
        id:
          type: string
          description: System-generated unique identifier (UUID)
          example: 7b9f2b65-1b4a-4f4c-9d9d-6a7f5b6d9b1a
        carrierCode:
          type: string
          description: Unique carrier code
          example: EVGL
        carrierName:
          type: string
          description: Carrier name
          example: Everglades
        cusip:
          type: string
          description: CUSIP identifier (9 characters)
          example: 1234567AB
          nullable: true
        productName:
          type: string
          description: Primary product name
          example: Term Life 20
        marketingName:
          type: string
          description: Marketing name for the product
          example: Everglades Term 20
        legalName:
          type: string
          description: Full legal name of the product
          example: Everglades Term Life Insurance – 20 Year Level Premium
        version:
          type: string
          description: Version identifier
          example: "1.0"
        versionStartDate:
          type: string
          description: Version start date
          example: 2025-01-01
        versionEndDate:
          type: string
          description: Version end date
          example: 2099-01-01
        line:
          type: string
          description: Product line classification
          enum:
            - LIFE
            - ANNUITY
          example: LIFE
        type:
          type: string
          description: Product type
          enum:
            - TERM
            - UNIVERSAL_LIFE
          example: TERM
        planCode:
          type: string
          description: Plan code
          example: EVGUL001
        availableToSell:
          type: boolean
          description: Whether the product is available to sell at product level
          example: true
        distributors:
          description: List of distributors authorized to sell this product
          nullable: true
          type: array
          items:
            $ref: "#/components/schemas/Distributor"
        stateAvailability:
          description: State-level availability records
          type: array
          items:
            $ref: "#/components/schemas/StateAvailability"
      required:
        - id
        - carrierCode
        - carrierName
        - productName
        - marketingName
        - legalName
        - version
        - versionStartDate
        - versionEndDate
        - line
        - type
        - planCode
        - availableToSell
        - stateAvailability
    Distributor:
      type: object
      properties:
        distributorCode:
          type: string
          description: Unique distributor code
          example: EVGL
        distributorName:
          type: string
          description: Distributor name
          example: Everglades Distribution
        startDate:
          type: string
          description: Start date of distributor authorization
          example: 2025-01-01
        endDate:
          type: string
          description: End date of distributor authorization
          example: 2099-01-01
      required:
        - distributorCode
        - distributorName
        - startDate
        - endDate
    StateAvailability:
      type: object
      properties:
        availableToSell:
          type: boolean
          description: Indicates whether the product is available to sell in this state
          example: true
        startDate:
          type: string
          description: Start date of state availability (inclusive)
          example: 2025-01-01
        endDate:
          type: string
          description: End date of state availability
          example: 2099-01-01
        abbreviation:
          type: string
          description: Two-letter state abbreviation
          example: NY
          minLength: 2
          maxLength: 2
        name:
          type: string
          description: Full state name
          example: New York
    PaginatedProductsResponse:
      type: object
      properties:
        count:
          type: number
          description: Total number of records matching the search
          example: 121
        next:
          type: string
          description: URL to the next page, if any
          example: /product/v2/products/search?offset=10&limit=10
          nullable: true
        previous:
          type: string
          description: URL to the previous page, if any
          example: ""
          nullable: true
        results:
          description: Array of products matching the search criteria
          type: array
          items:
            $ref: "#/components/schemas/ProductV2Model"
      required:
        - count
        - next
        - previous
        - results
```