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

# Provider directory summary (letter histogram, total, type counts)



## OpenAPI

````yaml /api/rs/openapi.json get /rs/providers/v1/summary
openapi: 3.0.3
info:
  title: KARE API
  description: Backend API for the KARE platform
  version: dev
servers:
  - url: http://localhost:3000
    description: Local dev
security: []
tags:
  - name: better-auth
    description: >-
      Better Auth's own endpoints (sign-in, session, MFA, password) - generated
      from the audience's live config via `generateOpenAPISchema()`, not
      hand-written.
paths:
  /rs/providers/v1/summary:
    get:
      tags:
        - providers
      summary: Provider directory summary (letter histogram, total, type counts)
      operationId: getProvidersSummaryRSV1
      parameters:
        - schema:
            type: string
            maxLength: 200
            example: lobby
          in: query
          name: whereName
          required: false
          description: Filter by name (contains, case-insensitive).
        - schema:
            type: string
            maxLength: 200
            example: lobby
          in: query
          name: whereLocation
          required: false
          description: Filter by location (contains, case-insensitive).
        - schema:
            type: array
            items:
              type: string
            example:
              - qualified_technician
              - approved_organization
          in: query
          name: whereTypes
          required: false
          description: Filter by provider type (matches any of the given codes).
        - schema:
            type: array
            items:
              type: string
            example:
              - A
              - B
          in: query
          name: whereNameInitial
          required: false
          description: Filter by the name initial (A-Z, or `#` for anything else).
        - schema:
            maxItems: 250
            type: array
            items:
              type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            example:
              - 550e8400-e29b-41d4-a716-446655440000
              - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
          in: query
          name: whereUnitIds
          required: false
          description: Narrow providers linked to the requested unit ids.
        - schema:
            maxItems: 250
            type: array
            items:
              type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            example:
              - 550e8400-e29b-41d4-a716-446655440000
              - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
          in: query
          name: whereITIds
          required: false
          description: Narrow providers linked to the requested technical installation ids.
        - schema:
            maxItems: 250
            type: array
            items:
              type: string
              format: uuid
              pattern: >-
                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            example:
              - 550e8400-e29b-41d4-a716-446655440000
              - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
          in: query
          name: whereLabelIds
          required: false
          description: Filter by linked label ids.
        - schema:
            anyOf:
              - type: boolean
              - type: string
            example: true
          in: query
          name: whereArchived
          required: false
          description: >-
            When `true`, only archived providers; when `false`, only
            non-archived.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  letters:
                    type: array
                    items:
                      type: object
                      properties:
                        letter:
                          type: string
                          minLength: 1
                          maxLength: 1
                          pattern: ^[A-Z#]$
                        count:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                      required:
                        - letter
                        - count
                      additionalProperties: false
                  totalCount:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  typeCounts:
                    type: object
                    properties:
                      qualified_technician:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      approved_organization:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                      training_provider:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                    required:
                      - qualified_technician
                      - approved_organization
                      - training_provider
                    additionalProperties: false
                required:
                  - letters
                  - totalCount
                  - typeCounts
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
                  details: {}
                required:
                  - error
                  - message
                  - requestId
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
                  details: {}
                required:
                  - error
                  - message
                  - requestId
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
                  details: {}
                required:
                  - error
                  - message
                  - requestId
                additionalProperties: false

````