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

# List LOBs

> List lines of business with optional filtering.

Filter by LOB categories, payer IDs, and/or states.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/lobs
openapi: 3.1.0
info:
  title: Penelope Health API
  description: REST API for querying the Penelope Health knowledge graph.
  version: 1.0.0
servers:
  - url: https://api-sandbox.penelope.health
    description: Sandbox
  - url: https://api.penelope.health
    description: Production
security: []
paths:
  /v1/lobs:
    get:
      summary: List LOBs
      description: |-
        List lines of business with optional filtering.

        Filter by LOB categories, payer IDs, and/or states.
      operationId: list_lobs_v1_lobs_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Maximum number of results to return
            examples:
              - 10
            default: 20
            title: Limit
          description: Maximum number of results to return
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            title: Offset
            description: Number of results to skip for pagination
            default: 0
            examples:
              - 0
          description: Number of results to skip for pagination
        - name: lobs
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  $ref: '#/components/schemas/LobCategory'
                type: array
              - type: 'null'
            description: Filter by LOB categories
            examples:
              - - commercial
            title: Lobs
          description: Filter by LOB categories
        - name: payer_ids
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by payer IDs
            examples:
              - - KMQTZ
            title: Payer Ids
          description: Filter by payer IDs
        - name: states
          in: query
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter by US state codes
            examples:
              - - CA
                - NY
            title: States
          description: Filter by US state codes
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_LineOfBusinessResponse_'
              example:
                data:
                  - lob_id: KMQTZ_commercial_US
                    payer_id: KMQTZ
                    payer_name: UnitedHealthcare
                    lob: commercial
                limit: 10
                offset: 0
                has_more: false
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    LobCategory:
      type: string
      enum:
        - commercial
        - medicare_part_a
        - medicare_part_b
        - medicare_advantage
        - medicare_part_d
        - medicaid
        - individual_aca
      title: LobCategory
      description: Line-of-business categories.
    PaginatedResponse_LineOfBusinessResponse_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/LineOfBusinessResponse'
          type: array
          title: Data
          description: Array of result objects
        limit:
          type: integer
          title: Limit
          description: Maximum number of results requested
          examples:
            - 20
        offset:
          type: integer
          title: Offset
          description: Number of results skipped for pagination
          examples:
            - 0
        has_more:
          type: boolean
          title: Has More
          description: True if more results exist beyond this page
          examples:
            - false
      type: object
      required:
        - data
        - limit
        - offset
        - has_more
      title: PaginatedResponse[LineOfBusinessResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LineOfBusinessResponse:
      properties:
        lob_id:
          type: string
          title: Lob Id
          description: Unique line-of-business identifier
          examples:
            - KMQTZ_commercial_US
            - HPQRS_medicare_part_b_CA
        payer_id:
          type: string
          title: Payer Id
          description: Unique Stedi payer ID (see https://www.stedi.com/healthcare/network)
          examples:
            - KMQTZ
            - HPQRS
        payer_name:
          type: string
          title: Payer Name
          description: Human-readable payer name
          examples:
            - UnitedHealthcare
            - Aetna
        lob:
          $ref: '#/components/schemas/LobCategory'
          description: Line-of-business category
          examples:
            - commercial
        state:
          anyOf:
            - $ref: '#/components/schemas/USState'
            - type: 'null'
          description: US state for this LOB. Null means nationwide.
          examples:
            - CA
      type: object
      required:
        - lob_id
        - payer_id
        - payer_name
        - lob
        - state
      title: LineOfBusinessResponse
      description: >-
        Line-of-business response model.


        `payer_name` is joined in from `payer.display_name` at query time — not
        a

        column on the `line_of_business` schema, hence no `@sync_with_schema`.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    USState:
      type: string
      enum:
        - AL
        - AK
        - AZ
        - AR
        - CA
        - CO
        - CT
        - DE
        - FL
        - GA
        - HI
        - ID
        - IL
        - IN
        - IA
        - KS
        - KY
        - LA
        - ME
        - MD
        - MA
        - MI
        - MN
        - MS
        - MO
        - MT
        - NE
        - NV
        - NH
        - NJ
        - NM
        - NY
        - NC
        - ND
        - OH
        - OK
        - OR
        - PA
        - RI
        - SC
        - SD
        - TN
        - TX
        - UT
        - VT
        - VA
        - WA
        - WV
        - WI
        - WY
        - DC
        - AS
        - GU
        - PR
        - VI
        - CNMI
        - NF
        - SF
        - DN
        - QN
        - UN
        - EM
        - WM
      title: USState
      description: >-
        US states, territories, and Medicare contractor jurisdictions.


        Includes standard 50 US states, DC, territories, and Medicare

        contractor jurisdiction subdivisions (e.g., Northern California, Queens
        NY).
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````