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

# Suggest relationships for search (household alias)

> Alias for `POST /api/v1/search/suggest-households`. Rewrites to suggest-households; response items use `householdId` and `name`.



## OpenAPI

````yaml /openapi.json post /api/v1/search/suggest-relationships
openapi: 3.0.3
info:
  title: Headlight API
  version: 1.0.0
  description: >-
    Initial public reference for a small subset of Headlight HTTP APIs. This
    document is maintained alongside the application; expand coverage only after
    verifying each operation against the live codebase. The in-browser API
    playground may not work from the docs domain without additional cross-origin
    configuration.
servers:
  - url: https://app.withheadlight.com
    description: Production
security: []
paths:
  /api/v1/search/suggest-relationships:
    post:
      tags:
        - Relationships
      summary: Suggest relationships for search (household alias)
      description: >-
        Alias for `POST /api/v1/search/suggest-households`. Rewrites to
        suggest-households; response items use `householdId` and `name`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
      responses:
        '200':
          description: Suggested households
          content:
            application/json:
              schema:
                type: object
                properties:
                  suggested:
                    type: array
                    items:
                      type: object
                      properties:
                        householdId:
                          type: string
                          format: uuid
                        name:
                          type: string
                      required:
                        - householdId
                        - name
                required:
                  - suggested
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimit'
      security:
        - BearerAuth: []
        - SessionAuth: []
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    RateLimit:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              resetAt:
                type: string
                format: date-time
  schemas:
    ErrorBody:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key authentication. Use `Authorization: Bearer idx_...`.'
    SessionAuth:
      type: apiKey
      in: cookie
      name: wos-session
      description: WorkOS session cookie from the Headlight web app.

````