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

# Get Provider Public Summary

> Get provider's public profile summary for client-facing use.

**Required scope:** `read`

Use this when:
- The AI Agent (Telegram, chat) needs to answer client questions about the provider
- Building a "provider info" tool for conversational flows
- Displaying provider info to prospects before a proposal exists

Returns only client-safe fields (no billing, tax, API keys, etc.).



## OpenAPI

````yaml /openapi/openapi-external.json get /provider/public-summary
openapi: 3.1.0
info:
  title: Quikly.ai External API
  version: 1.0.0
  description: >-
    REST API for external integrations with Quikly.ai. Authenticate using an API
    key passed in the X-API-Key header. Use these endpoints from n8n, Zapier,
    custom scripts, or any HTTP client.
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: Proposals
    description: Create, read, update, and manage client proposals.
  - name: Profile
    description: Read and update the authenticated user's profile.
  - name: Templates
    description: Manage reusable proposal templates.
  - name: AI Services
    description: >-
      AI-powered analysis: rate recommendations, brief analysis,
      differentiators.
  - name: Public API
  - name: Usage
    description: Query API usage and quota information.
  - name: Webhooks
    description: Manage webhook subscriptions for real-time events.
  - name: Agent
    description: Interact with the AI agent for automated workflows.
  - name: Lead Sessions
    description: Track and manage lead capture sessions.
paths:
  /provider/public-summary:
    get:
      tags:
        - Public API
      summary: Get Provider Public Summary
      description: >-
        Get provider's public profile summary for client-facing use.


        **Required scope:** `read`


        Use this when:

        - The AI Agent (Telegram, chat) needs to answer client questions about
        the provider

        - Building a "provider info" tool for conversational flows

        - Displaying provider info to prospects before a proposal exists


        Returns only client-safe fields (no billing, tax, API keys, etc.).
      operationId: get_provider_public_summary_api_external_v1_provider_public_summary_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderPublicSummaryResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    ProviderPublicSummaryResponse:
      properties:
        companyName:
          type: string
          title: Companyname
          default: ''
        slogan:
          type: string
          title: Slogan
          default: ''
        name:
          type: string
          title: Name
          default: ''
        bio:
          anyOf:
            - type: string
            - type: 'null'
          title: Bio
        yearsOfExperience:
          anyOf:
            - type: integer
            - type: 'null'
          title: Yearsofexperience
        portfolioUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Portfoliourl
        githubUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Githuburl
        linkedinUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Linkedinurl
        skills:
          items:
            type: string
          type: array
          title: Skills
        providerType:
          type: string
          title: Providertype
          default: freelancer
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
        seniority:
          anyOf:
            - type: string
            - type: 'null'
          title: Seniority
        location:
          anyOf:
            - type: string
            - type: 'null'
          title: Location
        website:
          anyOf:
            - type: string
            - type: 'null'
          title: Website
        orgDescription:
          anyOf:
            - type: string
            - type: 'null'
          title: Orgdescription
        orgServices:
          items:
            type: string
          type: array
          title: Orgservices
        orgClients:
          anyOf:
            - type: string
            - type: 'null'
          title: Orgclients
        teamSize:
          anyOf:
            - type: integer
            - type: 'null'
          title: Teamsize
        summaryText:
          type: string
          title: Summarytext
          description: 2-3 line summary for LLM context or display
          default: ''
      type: object
      title: ProviderPublicSummaryResponse
      description: >-
        Summary of the provider's public profile for client-facing contexts.

        Use this when the client asks about the provider (experience, services,
        etc.).

        Safe to expose to prospects—excludes billing, tax, and internal data.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from Quikly.ai Settings → API Keys.
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````