Rainbow Appetite API

openapi: 3.2.0
info:
  description: Rainbow Open API is currently in preview for selected insurance partners.
  title: Rainbow Appetite API
  contact:
    name: API Support
    email: support@userainbow.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
- url: //api.demo.userainbow.com/partner/api/v1
tags:
- name: Appetite
paths:
  /appetite:
    get:
      security:
      - ApiKeyAuthV1: []
      description: The endpoint enables you to query insurance appetites based on given state and class codes.
      tags:
      - Appetite
      summary: Query Appetite
      parameters:
      - description: Comma-separated list of state codes.
        name: state_codes
        in: query
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - description: Comma-separated list of NAICS class codes.
        name: class_codes
        in: query
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - description: If set to true, the response will include related questions for the queried appetites.
        name: include_questions
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.AppetiteResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Response'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Response'
      operationId: getAppetite
      x-operation-id-source: derived
components:
  schemas:
    model.Response:
      type: object
      properties:
        data: {}
        errors: {}
        message:
          type: string
        status:
          type: integer
        timestamp:
          type: string
    model.AppetiteResponseData:
      type: object
      properties:
        available:
          description: Indicates the availability of a product within the queried appetite.
          type: boolean
        class_code:
          description: Reflects the NAICS class code used in the query.
          type: string
        product_code:
          description: Code representing the insurance product linked to the queried appetite.
          type: string
        product_expiration:
          description: String representing the expiration timestamp of the product requested
          type: string
        product_version:
          description: String representing the version of the product requested
          type: string
        questions:
          description: A list of questions related to the queried appetite. These are included when include_questions is set to true.
          type: array
          items:
            $ref: '#/components/schemas/monolith_endpoint_partner_model.Question'
        state_code:
          description: Echoes the state code used in the query.
          type: string
    model.AppetiteResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/model.AppetiteResponseData'
        errors: {}
        message:
          type: string
        status:
          type: integer
        timestamp:
          type: string
    monolith_endpoint_partner_model.Question:
      type: object
      properties:
        is_optional:
          description: IsOptional question. Not required, but can be answered if applicable.
          type: boolean
        key:
          description: Identifier for the question.
          type: string
        options:
          description: Values representing the answer options, if applicable.
          type: array
          items:
            type: string
        prompt:
          description: The question text.
          type: string
        type:
          description: The data type of the answer (can be “string”, “number”, “boolean”, “time”, “list”).
          type: string
  securitySchemes:
    ApiKeyAuthV1:
      type: apiKey
      name: Authorization
      in: header
x-provenance:
  method: searched
  source: https://apidocs.userainbow.com/reference
  harvested: '2026-10-25'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.userainbow.com/reference/get_appetite.md
  - https://apidocs.userainbow.com/reference/get_indication-id-indicationid.md
  - https://apidocs.userainbow.com/reference/get_sub-agency-id-subagencyid-agent-id-agentid.md
  - https://apidocs.userainbow.com/reference/get_sub-agency-id-subagencyid-agents.md
  - https://apidocs.userainbow.com/reference/get_sub-agency-id-subagencyid.md
  - https://apidocs.userainbow.com/reference/get_sub-agency-npn-npn.md
  - https://apidocs.userainbow.com/reference/post_indication.md
  - https://apidocs.userainbow.com/reference/post_sub-agency-id-subagencyid-agent.md
  - https://apidocs.userainbow.com/reference/post_sub-agency.md
  merge:
    pages: 9
    deduped: 37
    conflicts_kept_first: 0