> ## 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 Profile

> Get your user profile.

**Required scope:** `read`

Returns all profile information including company details, 
role, seniority, location, and AI configuration.



## OpenAPI

````yaml /openapi/openapi-external.json get /profile
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:
  /profile:
    get:
      tags:
        - Public API
      summary: Get Profile
      description: |-
        Get your user profile.

        **Required scope:** `read`

        Returns all profile information including company details, 
        role, seniority, location, and AI configuration.
      operationId: get_profile_api_external_v1_profile_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
      security:
        - APIKeyHeader: []
components:
  schemas:
    UserResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        user_type:
          type: string
          title: User Type
          default: provider
        email_verified:
          type: boolean
          title: Email Verified
          default: false
        profile:
          type: object
          title: Profile
          default: {}
        effective_tier:
          type: string
          title: Effective Tier
          default: free
        is_admin:
          type: boolean
          title: Is Admin
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
        team_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Team Id
        team_role:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Role
        team_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Name
      type: object
      required:
        - id
        - email
        - created_at
      title: UserResponse
      description: Schema for user response.
  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

````