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

# Get an associated product resource

> Fetch one current explicitly associated resource, its state/component metadata and ordered tags. Copy the opaque id from listProductResources. Removed associations, and resources associated only with states the plan does not cover, return 404. sourceId identifies the existing file or filing; this operation grants no new download permission. Safe to retry.



## OpenAPI

````yaml /openapi.json get /insurance/products/{productId}/resources/{resourceId}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /insurance/products/{productId}/resources/{resourceId}:
    get:
      tags:
        - Products
      summary: Get an associated product resource
      description: >-
        Fetch one current explicitly associated resource, its state/component
        metadata and ordered tags. Copy the opaque id from listProductResources.
        Removed associations, and resources associated only with states the plan
        does not cover, return 404. sourceId identifies the existing file or
        filing; this operation grants no new download permission. Safe to retry.
      operationId: getProductResource
      parameters:
        - schema:
            type: string
            description: >-
              Managed product_ ID or bare checked code; case-insensitive with
              Crockford aliases.
          required: true
          description: >-
            Managed product_ ID or bare checked code; case-insensitive with
            Crockford aliases.
          name: productId
          in: path
        - schema:
            $ref: '#/components/schemas/V2ProductResourceId'
          required: true
          name: resourceId
          in: path
      responses:
        '200':
          description: Associated resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ProductResource'
        '400':
          description: >-
            Invalid request, unresolved reference, or invalid_cursor; restart
            without cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            plan_required: reads need an Effective API plan covering the
            product, checked first, and any state filter. Writes need Super
            Admin credentials (forbidden).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Product or associated resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Concurrent reference conflict.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable; honor Retry-After seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ProductResourceId:
      type: string
      pattern: >-
        ^(file|filing):[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    V2ProductResource:
      type: object
      properties:
        id:
          type: string
          pattern: >-
            ^(file|filing):[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        kind:
          type: string
          enum:
            - file
            - filing
        sourceId:
          type: string
          format: uuid
        name:
          type: string
        associations:
          type: array
          items:
            type: object
            properties:
              state:
                type: string
              component:
                type: string
                enum:
                  - rate_manual
                  - uw_manual
                  - form
                  - filing
              source:
                type: string
                enum:
                  - web
                  - serff
              url:
                type: string
                nullable: true
              filing:
                type: object
                nullable: true
                properties:
                  id:
                    type: string
                    format: uuid
                  trackingNumber:
                    type: string
                    nullable: true
                required:
                  - id
                  - trackingNumber
                additionalProperties: false
              form:
                type: object
                nullable: true
                properties:
                  formNumber:
                    type: string
                  edition:
                    type: string
                    nullable: true
                  title:
                    type: string
                    nullable: true
                  formType:
                    type: string
                    nullable: true
                required:
                  - formNumber
                  - edition
                  - title
                  - formType
                additionalProperties: false
            required:
              - state
              - component
              - source
              - url
              - filing
              - form
            additionalProperties: false
        tags:
          type: array
          items:
            type: object
            properties:
              ref:
                type: string
                minLength: 1
                maxLength: 2000
            required:
              - ref
            additionalProperties: false
        match:
          type: string
          nullable: true
          enum:
            - direct
            - general
            - null
      required:
        - id
        - kind
        - sourceId
        - name
        - associations
        - tags
        - match
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
            upgradeUrl:
              type: string
              nullable: true
              format: uri
              description: Where to upgrade for plan_required, when available.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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