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

# Get customizable company profile

> Retrieve a company profile, choosing which sections to return. Use `include` (comma-separated) to request specific sections — pass `full` to return everything. Use `exclude` (comma-separated) to drop sections from the response. Set `sources=true` to receive source citations alongside the profile content.



## OpenAPI

````yaml https://api.getpg.ai/docs/v1/openapi.json get /companies/{company_id}/profile
openapi: 3.0.0
info:
  title: PG:AI Public API
  version: 1.0.0
  description: >-
    Public API for accessing PG:AI account intelligence, contacts, territories,
    and more. All endpoints require API key authentication via the x-api-key
    header.
  contact:
    name: PG:AI Support
    url: https://www.getpg.ai
servers:
  - url: https://api.getpg.ai/public-api/v1
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /companies/{company_id}/profile:
    get:
      tags:
        - companies
      summary: Get customizable company profile
      description: >-
        Retrieve a company profile, choosing which sections to return. Use
        `include` (comma-separated) to request specific sections — pass `full`
        to return everything. Use `exclude` (comma-separated) to drop sections
        from the response. Set `sources=true` to receive source citations
        alongside the profile content.
      parameters:
        - name: company_id
          in: path
          required: true
          schema:
            type: string
          description: Company ID (UUID)
        - name: include
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - full
                - overview
                - key_executives
                - divisions
                - geographical_operations
                - swot_analysis
                - competitors
                - industry_insights
                - strategic_priorities
                - digital_strategies
                - risks
                - goals
                - insights_scores
                - events
                - value_pyramid
                - three_whys
                - discovery_questions
                - how_they_make_money
                - how_they_lose_money
                - custom_insights
                - employee_groups
                - favourite_technologies_count
                - territory_custom_scores
                - content
          description: >-
            Comma-separated list of sections to include. Pass `full` to return
            every section.
          style: form
          explode: false
          example: overview,key_executives,swot_analysis
        - name: exclude
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - full
                - overview
                - key_executives
                - divisions
                - geographical_operations
                - swot_analysis
                - competitors
                - industry_insights
                - strategic_priorities
                - digital_strategies
                - risks
                - goals
                - insights_scores
                - events
                - value_pyramid
                - three_whys
                - discovery_questions
                - how_they_make_money
                - how_they_lose_money
                - custom_insights
                - employee_groups
                - favourite_technologies_count
                - territory_custom_scores
                - content
          description: Comma-separated list of sections to omit from the response.
          style: form
          explode: false
          example: risks,competitors
        - name: sources
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: When `true`, include source citations alongside the profile content.
          example: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyProfile'
        '400':
          description: Input Error. Check the request payload for issues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Access denied. Additional privileges are needed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found. The requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate Limited. Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CompanyProfile:
      type: object
      description: Customizable company profile with optional sections
      properties:
        company_id:
          type: string
          format: uuid
        company_name:
          type: string
        website_domain:
          type: string
        hq_country_name:
          type: string
          nullable: true
        industry:
          type: string
          nullable: true
        revenue_range:
          type: string
          nullable: true
        employee_count_range:
          type: string
          nullable: true
        overview:
          type: object
          description: Company overview section
          additionalProperties: true
        divisions:
          type: array
          description: Company divisions
          items:
            type: object
            properties:
              division_name:
                type: string
              division_summary:
                type: string
              last_year_label:
                type: string
              last_year_financial_year_end:
                type: string
              last_year_revenue_gross:
                type: number
              last_year_gross_revenue_change:
                type: string
              year_before_label:
                type: string
              year_before_financial_year_end:
                type: string
              year_before_revenue_gross:
                type: number
              year_before_gross_revenue_change:
                type: string
              priorities:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    sources:
                      type: array
                      items:
                        type: object
                    description:
                      type: string
              challenges:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    sources:
                      type: array
                      items:
                        type: object
                    description:
                      type: string
              digital_strategies:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    sources:
                      type: array
                      items:
                        type: object
                    description:
                      type: string
              key_people:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    source:
                      type: string
                    description:
                      type: string
        key_executives:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              title:
                type: string
        geographical_operations:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        swot_analysis:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                enum:
                  - STRENGTH
                  - WEAKNESS
                  - OPPORTUNITY
                  - THREAT
              description:
                type: string
        strategic_priorities:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        digital_strategies:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        goals:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        risks:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        competitors:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              website:
                type: string
                format: uri
              description:
                type: string
        industry_insights:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              sources:
                type: array
                items:
                  type: object
              description:
                type: string
        events:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              event_title:
                type: string
              fiscal_label:
                type: string
              period_end_date:
                type: string
                format: date
              gross_revenue:
                type: number
              gross_revenue_change:
                type: string
              earnings_call_new_strategies:
                type: array
                items:
                  type: object
              earnings_call_summary:
                type: array
                items:
                  type: object
              earnings_call_quotes:
                type: array
                items:
                  type: object
              event_new_strategies:
                type: array
                items:
                  type: object
              earnings_call_challenges:
                type: array
                items:
                  type: object
              digital_strategies:
                type: array
                items:
                  type: object
        custom_insights:
          type: array
          items:
            type: object
        insights_scores:
          type: array
          items:
            type: object
        territory_custom_scores:
          type: array
          items:
            type: object
      required:
        - company_id
    Error:
      type: object
      description: Error response
      properties:
        error:
          type: string
          description: Error type or code
        message:
          type: string
          description: Human-readable error message
        details:
          type: object
          description: Additional error details
          additionalProperties: true
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key for authentication. Get your API key from the PG:AI
        dashboard under Settings > API Keys.

````