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

# Detail



## OpenAPI

````yaml /openapi.json get /v1/workspaces/{workspaceId}/catalog-families/{id}/lifecycle
openapi: 3.1.0
info:
  title: Specurate API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://app.specurate.com/api
    description: API Server
security: []
tags: []
paths:
  /v1/workspaces/{workspaceId}/catalog-families/{id}/lifecycle:
    get:
      tags:
        - Catalog Family Lifecycle
      summary: Detail
      operationId: CatalogFamilyLifecycleController_detail_v1
      parameters:
        - name: workspaceId
          required: true
          in: path
          schema:
            type: string
        - name: id
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifecycleDetailResponseDto'
components:
  schemas:
    LifecycleDetailResponseDto:
      type: object
      properties:
        item:
          $ref: '#/components/schemas/LifecycleItem'
        snapshot:
          $ref: '#/components/schemas/LifecycleSnapshot'
      required:
        - item
        - snapshot
    LifecycleItem:
      type: object
      properties:
        id:
          type: string
        version:
          type: number
        state:
          type: string
          enum:
            - active
            - archived
            - deleted
        name:
          type: string
        referenceNumber:
          type:
            - string
            - 'null'
        imageUrl:
          type:
            - string
            - 'null'
        categoryName:
          type:
            - string
            - 'null'
        areaNames:
          type: array
          items:
            type: string
        supplierName:
          type:
            - string
            - 'null'
        archivedAt:
          type:
            - string
            - 'null'
        archivedBy:
          anyOf:
            - $ref: '#/components/schemas/LifecycleActor'
            - type: 'null'
        archiveReason:
          type:
            - string
            - 'null'
        deletedAt:
          type:
            - string
            - 'null'
        deletedBy:
          anyOf:
            - $ref: '#/components/schemas/LifecycleActor'
            - type: 'null'
        expiresAt:
          type:
            - string
            - 'null'
      required:
        - id
        - version
        - state
        - name
        - referenceNumber
        - imageUrl
        - categoryName
        - areaNames
        - supplierName
        - archivedAt
        - archivedBy
        - archiveReason
        - deletedAt
        - deletedBy
        - expiresAt
    LifecycleSnapshot:
      type: object
      properties:
        name:
          type: string
        itemType:
          type: string
          enum:
            - default
            - material
        materialFinish:
          $ref: '#/components/schemas/LifecycleMaterialFinish'
        areaQuantity:
          $ref: '#/components/schemas/LifecycleAreaQuantity'
        sourceMeta:
          anyOf:
            - $ref: '#/components/schemas/ProjectItemSourceMetaDto'
            - type: 'null'
        collectionApplication:
          anyOf:
            - $ref: '#/components/schemas/CollectionApplicationProvenanceDto'
            - type: 'null'
        catalogFamilyStatus:
          type:
            - string
            - 'null'
          enum:
            - draft
            - new_from_project
            - new_from_collection
            - ready_to_use
            - null
        catalogSourceState:
          type: string
          enum:
            - active
            - archived
            - deleted
            - purged
        syncStateCache:
          anyOf:
            - $ref: '#/components/schemas/SyncStateCacheDto'
            - type: 'null'
        categoryId:
          type:
            - string
            - 'null'
        productTypeId:
          type:
            - string
            - 'null'
        productTypeName:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        metadata:
          type: object
          additionalProperties:
            type: string
        images:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              url:
                type: string
              filename:
                type: string
              isPrimary:
                type: boolean
              version:
                type: number
              createdAt:
                type: string
              updatedAt:
                type: string
            required:
              - id
              - url
              - filename
              - isPrimary
              - version
              - createdAt
              - updatedAt
        resolvedGuidance:
          $ref: '#/components/schemas/CategoryGuidanceResponseDto'
        instructionLinks:
          type: array
          items:
            $ref: '#/components/schemas/ProjectItemInstructionLinkResponseDto'
        linkedInstructions:
          type: array
          items:
            $ref: '#/components/schemas/LinkedInstructionResponseDto'
        quantity:
          type:
            - string
            - 'null'
        manufacturerName:
          type:
            - string
            - 'null'
        referenceNumber:
          type:
            - string
            - 'null'
        imageUrl:
          type:
            - string
            - 'null'
        categoryName:
          type:
            - string
            - 'null'
        areaNames:
          type: array
          items:
            type: string
        supplierName:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
        projectName:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        attributes:
          type: object
          additionalProperties: true
        attributeLabels:
          type: object
          additionalProperties:
            type: string
        attributeColumns:
          type: array
          items:
            $ref: '#/components/schemas/ItemColumnResponseDto'
        instructions:
          type: array
          items:
            type: object
            properties:
              label:
                type:
                  - string
                  - 'null'
              texts:
                type: array
                items:
                  type: string
            required:
              - label
              - texts
        requirements:
          type: array
          items:
            type: object
            properties:
              label:
                type:
                  - string
                  - 'null'
              texts:
                type: array
                items:
                  type: string
            required:
              - label
              - texts
        furnishedInstalledBy:
          type:
            - string
            - 'null'
        components:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              linkId:
                type: string
              categoryId:
                type: string
              catalogFamilyId:
                type: string
              catalogItemId:
                type: string
              attributes:
                type: object
                additionalProperties: true
              primaryImageUrl:
                type:
                  - string
                  - 'null'
              primaryImageId:
                type:
                  - string
                  - 'null'
              materialFinish:
                $ref: '#/components/schemas/LifecycleMaterialFinish'
              parentQuantity:
                type: string
              totalQuantity:
                type: string
              totalPrice:
                type:
                  - string
                  - 'null'
              totalPriceOverridden:
                type: boolean
              name:
                type: string
              kind:
                enum:
                  - material
                  - component
                type: string
              quantity:
                type: string
              categoryName:
                type:
                  - string
                  - 'null'
              finish:
                type:
                  - string
                  - 'null'
              unit:
                type:
                  - string
                  - 'null'
            required:
              - id
              - name
              - kind
              - quantity
              - categoryName
              - finish
              - unit
        relatedItems:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
            required:
              - id
              - name
        stoppedWorkflows:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              kind:
                type: string
              name:
                type: string
            required:
              - id
              - kind
              - name
      required:
        - name
        - quantity
        - manufacturerName
        - referenceNumber
        - imageUrl
        - categoryName
        - areaNames
        - supplierName
        - status
        - projectName
        - description
        - attributes
        - attributeLabels
        - attributeColumns
        - instructions
        - requirements
        - furnishedInstalledBy
        - components
        - relatedItems
        - stoppedWorkflows
    LifecycleActor:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
    LifecycleMaterialFinish:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        isBaseMaterial:
          type: boolean
        imageId:
          type:
            - string
            - 'null'
      required:
        - id
        - name
        - isBaseMaterial
    LifecycleAreaQuantity:
      type: object
      properties:
        areas:
          type: array
          items:
            $ref: '#/components/schemas/ProjectAreaAllocationAreaResponseDto'
        allocations:
          type: array
          items:
            $ref: '#/components/schemas/ProjectAreaAllocationResponseDto'
        instanceTags:
          type: array
          items:
            type: object
            properties:
              areaId:
                type: string
              tags:
                type:
                  - array
                  - 'null'
                items:
                  type: string
            required:
              - areaId
              - tags
        roomQuantities:
          type: array
          items:
            type: object
            properties:
              areaId:
                type: string
              roomIndex:
                type: number
              roomNumber:
                type: string
              quantity:
                type: string
              version:
                type: number
            required:
              - areaId
              - roomIndex
              - roomNumber
              - quantity
              - version
        slotQuantity:
          type: string
        allocatedTotal:
          type: string
        extraQuantityPercentage:
          type:
            - string
            - 'null'
        extraQuantityOverride:
          type:
            - string
            - 'null'
        extraQuantityDecimalPlaces:
          type:
            - number
            - 'null'
        unitsPerPackage:
          type:
            - string
            - 'null'
        parLevel:
          type:
            - string
            - 'null'
        applyParToPurchaseQuantity:
          type: boolean
        hasPrimaryOption:
          type: boolean
      required:
        - areas
        - allocations
        - instanceTags
        - roomQuantities
        - slotQuantity
        - allocatedTotal
        - extraQuantityPercentage
        - extraQuantityOverride
        - extraQuantityDecimalPlaces
        - unitsPerPackage
        - parLevel
        - applyParToPurchaseQuantity
        - hasPrimaryOption
    ProjectItemSourceMetaDto:
      type: object
      properties:
        selectors:
          type: object
          additionalProperties:
            type: string
          description: Column slug → CSS selector of the clipped page element.
        url:
          type: string
          maxLength: 2048
          format: uri
        title:
          type: string
          maxLength: 512
        favicon:
          type: string
          maxLength: 2048
        ogImage:
          type: string
          maxLength: 2048
        clippedAt:
          type: string
      required:
        - url
    CollectionApplicationProvenanceDto:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/CollectionApplicationCollectionProvenanceDto'
        entry:
          $ref: '#/components/schemas/CollectionApplicationEntryProvenanceDto'
        reference:
          anyOf:
            - $ref: '#/components/schemas/CollectionApplicationReferenceProvenanceDto'
            - type: 'null'
        application:
          $ref: '#/components/schemas/CollectionApplicationIdentityProvenanceDto'
        content:
          $ref: '#/components/schemas/CollectionApplicationContentProvenanceDto'
        governance:
          $ref: '#/components/schemas/CollectionApplicationGovernanceProvenanceDto'
      required:
        - collection
        - entry
        - reference
        - application
        - content
        - governance
    SyncStateCacheDto:
      type: object
      properties:
        hasDiff:
          type: boolean
          description: >-
            Status-worthy drift: core columns, taxonomy, invalid source binding,
            or parts; descriptive-only column changes are excluded
        columnsDiff:
          type: boolean
          description: >-
            Any physical catalog-owned column delta, including descriptive
            fields; a supplier price or lead time is never one. This can be true
            while hasDiff is false
        partsDiff:
          $ref: '#/components/schemas/PartsDiffDto'
        selectionDiff:
          $ref: '#/components/schemas/SelectionDiffDto'
        orphanedRefs:
          $ref: '#/components/schemas/OrphanedRefsDto'
        computedAt:
          type: string
        componentsDiverged:
          type: boolean
      required:
        - hasDiff
        - columnsDiff
        - partsDiff
        - selectionDiff
        - orphanedRefs
        - computedAt
        - componentsDiverged
    CategoryGuidanceResponseDto:
      type: object
      properties:
        ownedInstructions:
          type: array
          items:
            $ref: '#/components/schemas/NativeInstructionResponseDto'
        ownerVersion:
          type: number
        linkedInstructions:
          type: array
          items:
            $ref: '#/components/schemas/LinkedInstructionResponseDto'
        revision:
          type: number
        classification:
          type: object
          properties:
            categoryId:
              type: string
            productTypeId:
              type:
                - string
                - 'null'
          required:
            - categoryId
            - productTypeId
        instructions:
          type: array
          items:
            $ref: '#/components/schemas/ResolvedCategoryGuidanceGroupDto'
        requirements:
          type: array
          items:
            $ref: '#/components/schemas/ResolvedCategoryGuidanceGroupDto'
        furnishedInstalledBy:
          type: object
          properties:
            value:
              type:
                - string
                - 'null'
              enum:
                - OFCI
                - OFOI
                - CFCI
                - CFOI
                - HFHI
                - null
            origin:
              enum:
                - none
                - item-override
                - category-default
              type: string
          required:
            - value
            - origin
      required:
        - revision
        - classification
        - instructions
        - requirements
        - furnishedInstalledBy
    ProjectItemInstructionLinkResponseDto:
      type: object
      properties:
        assigneeRoleGroupIds:
          type: array
          items:
            type: string
            enum:
              - mfg_vendors
              - owners
              - gc_sub
              - warehouse
        id:
          type: string
        kind:
          enum:
            - instruction
            - requirement
          type: string
        text:
          type: string
        position:
          type: number
      required:
        - assigneeRoleGroupIds
        - id
        - kind
        - text
        - position
    LinkedInstructionResponseDto:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        assigneeRoleGroupIds:
          type: array
          items:
            type: string
            enum:
              - warehouse
              - mfg_vendors
              - owners
              - gc_sub
        key:
          type: string
        source:
          $ref: '#/components/schemas/InstructionSourceResponseDto'
        disabled:
          type: boolean
      required:
        - id
        - text
        - assigneeRoleGroupIds
        - key
        - source
        - disabled
    ItemColumnResponseDto:
      type: object
      properties:
        isCore:
          type: boolean
          deprecated: true
        id:
          type: string
        name:
          type: string
        slug:
          type: string
        type:
          enum:
            - text
            - number
            - percent
            - boolean
            - list
            - multiple_select
            - date
            - image
            - dimension
          type: string
        logicType:
          enum:
            - catalog_family
            - catalog_item
            - catalog_family_source
            - catalog_item_source
            - project_item
            - project_item_slot
          type: string
        scopeType:
          enum:
            - default
            - category
          type: string
        categoryIds:
          type: array
          items:
            type: string
        categoryPositions:
          type: object
          additionalProperties:
            type: number
        options:
          type: array
          items:
            type: object
        description:
          type:
            - string
            - 'null'
        syncClass:
          enum:
            - core
            - commercial
            - descriptive
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - isCore
        - id
        - name
        - slug
        - type
        - logicType
        - scopeType
        - categoryIds
        - options
        - description
        - syncClass
        - createdAt
        - updatedAt
    ProjectAreaAllocationAreaResponseDto:
      type: object
      properties:
        areaId:
          type: string
        parentId:
          type:
            - string
            - 'null'
        level:
          type: number
        levelKey:
          type: string
        levelLabel:
          type: string
        code:
          type:
            - string
            - 'null'
        name:
          type: string
        multiplier:
          type: number
        instanceTags:
          type:
            - array
            - 'null'
          items:
            type: string
        effectiveInstanceCount:
          type: string
        ancestorPath:
          type: array
          items:
            $ref: '#/components/schemas/ProjectAreaAllocationAncestorResponseDto'
      required:
        - areaId
        - parentId
        - level
        - levelKey
        - levelLabel
        - code
        - name
        - multiplier
        - instanceTags
        - effectiveInstanceCount
        - ancestorPath
    ProjectAreaAllocationResponseDto:
      type: object
      properties:
        id:
          type: string
        slotId:
          type: string
        areaId:
          type: string
        quantity:
          type: string
        effectiveQuantity:
          type: string
        version:
          type: number
      required:
        - id
        - slotId
        - areaId
        - quantity
        - effectiveQuantity
        - version
    CollectionApplicationCollectionProvenanceDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        brand:
          type: string
        regions:
          type: array
          items:
            type: string
        generation:
          type: number
        version:
          type: number
        navigable:
          type: boolean
      required:
        - id
        - name
        - brand
        - regions
        - generation
        - version
        - navigable
    CollectionApplicationEntryProvenanceDto:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        productTypeLabel:
          type: string
        productTypeId:
          type:
            - string
            - 'null'
      required:
        - id
        - label
        - productTypeLabel
        - productTypeId
    CollectionApplicationReferenceProvenanceDto:
      type: object
      properties:
        label:
          type: string
        kind:
          type: string
          enum:
            - catalog_item
        referenceCode:
          type:
            - string
            - 'null'
      required:
        - label
        - kind
        - referenceCode
    CollectionApplicationIdentityProvenanceDto:
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: string
      required:
        - id
        - createdAt
    CollectionApplicationContentProvenanceDto:
      type: object
      properties:
        referenceNumber:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        notes:
          type: array
          items:
            type: string
      required:
        - referenceNumber
        - description
        - notes
    CollectionApplicationGovernanceProvenanceDto:
      type: object
      properties:
        mandatoryItem:
          type: boolean
        designReviewRequired:
          type: boolean
        optionalManufacturerNames:
          type: array
          items:
            type: string
      required:
        - mandatoryItem
        - designReviewRequired
        - optionalManufacturerNames
    PartsDiffDto:
      type: object
      properties:
        hasDiff:
          type: boolean
        addedLocally:
          type: array
          items:
            type: string
        removedLocally:
          type: array
          items:
            type: string
        quantityChanged:
          type: array
          items:
            $ref: '#/components/schemas/PartsDiffEntryDto'
      required:
        - hasDiff
        - addedLocally
        - removedLocally
        - quantityChanged
    SelectionDiffDto:
      type: object
      properties:
        familySourceMismatch:
          type: boolean
          description: true when the selected family-source binding is incomplete
        itemSourceMismatch:
          type: boolean
          description: true when the selected item-source binding is incomplete
      required:
        - familySourceMismatch
        - itemSourceMismatch
    OrphanedRefsDto:
      type: object
      properties:
        family:
          type: boolean
        item:
          type: boolean
        familySource:
          type: boolean
        itemSource:
          type: boolean
      required:
        - family
        - item
        - familySource
        - itemSource
    NativeInstructionResponseDto:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        assigneeRoleGroupIds:
          type: array
          items:
            type: string
            enum:
              - warehouse
              - mfg_vendors
              - owners
              - gc_sub
      required:
        - id
        - text
        - assigneeRoleGroupIds
    ResolvedCategoryGuidanceGroupDto:
      type: object
      properties:
        groupId:
          type: string
        groupLineageId:
          type: string
        groupLabel:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResolvedCategoryGuidanceItemDto'
      required:
        - groupId
        - groupLineageId
        - groupLabel
        - items
    InstructionSourceResponseDto:
      type: object
      properties:
        kind:
          type: string
          enum:
            - catalog
            - collection
        id:
          type: string
        name:
          type: string
        version:
          type: number
        collectionId:
          type: string
        collectionVersion:
          type: number
      required:
        - kind
        - id
        - name
        - version
    ProjectAreaAllocationAncestorResponseDto:
      type: object
      properties:
        id:
          type: string
        code:
          type:
            - string
            - 'null'
        name:
          type: string
      required:
        - id
        - code
        - name
    PartsDiffEntryDto:
      type: object
      properties:
        catalogItemId:
          type: string
        projectQty:
          type:
            - string
            - 'null'
        catalogQty:
          type:
            - string
            - 'null'
      required:
        - catalogItemId
        - projectQty
        - catalogQty
    ResolvedCategoryGuidanceItemDto:
      type: object
      properties:
        id:
          type: string
        lineageId:
          type: string
        text:
          type: string
        assigneeRoleGroupIds:
          type: array
          items:
            type: string
            enum:
              - warehouse
              - mfg_vendors
              - owners
              - gc_sub
        position:
          type: number
        origin:
          type: string
          enum:
            - category
            - item-disabled
            - entry
      required:
        - id
        - lineageId
        - text
        - assigneeRoleGroupIds
        - position
        - origin

````

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