Skip to main content
GET
/
companies
/
{company_id}
/
profile
Get customizable company profile
curl --request GET \
  --url https://api.getpg.ai/v1/companies/{company_id}/profile \
  --header 'X-Api-Key: <api-key>'
{
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "website_domain": "<string>",
  "hq_country_name": "<string>",
  "industry": "<string>",
  "revenue_range": "<string>",
  "employee_count_range": "<string>",
  "overview": {},
  "divisions": [
    {
      "division_name": "<string>",
      "division_summary": "<string>",
      "last_year_label": "<string>",
      "last_year_financial_year_end": "<string>",
      "last_year_revenue_gross": 123,
      "last_year_gross_revenue_change": "<string>",
      "year_before_label": "<string>",
      "year_before_financial_year_end": "<string>",
      "year_before_revenue_gross": 123,
      "year_before_gross_revenue_change": "<string>",
      "priorities": [
        {
          "name": "<string>",
          "sources": [
            {}
          ],
          "description": "<string>"
        }
      ],
      "challenges": [
        {
          "name": "<string>",
          "sources": [
            {}
          ],
          "description": "<string>"
        }
      ],
      "digital_strategies": [
        {
          "name": "<string>",
          "sources": [
            {}
          ],
          "description": "<string>"
        }
      ],
      "key_people": [
        {
          "name": "<string>",
          "source": "<string>",
          "description": "<string>"
        }
      ]
    }
  ],
  "key_executives": [
    {
      "name": "<string>",
      "title": "<string>"
    }
  ],
  "geographical_operations": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "swot_analysis": [
    {
      "name": "<string>",
      "type": "STRENGTH",
      "description": "<string>"
    }
  ],
  "strategic_priorities": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "digital_strategies": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "goals": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "risks": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "competitors": [
    {
      "name": "<string>",
      "website": "<string>",
      "description": "<string>"
    }
  ],
  "industry_insights": [
    {
      "name": "<string>",
      "sources": [
        {}
      ],
      "description": "<string>"
    }
  ],
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "event_title": "<string>",
      "fiscal_label": "<string>",
      "period_end_date": "2023-12-25",
      "gross_revenue": 123,
      "gross_revenue_change": "<string>",
      "earnings_call_new_strategies": [
        {}
      ],
      "earnings_call_summary": [
        {}
      ],
      "earnings_call_quotes": [
        {}
      ],
      "event_new_strategies": [
        {}
      ],
      "earnings_call_challenges": [
        {}
      ],
      "digital_strategies": [
        {}
      ]
    }
  ],
  "custom_insights": [
    {}
  ],
  "insights_scores": [
    {}
  ],
  "territory_custom_scores": [
    {}
  ]
}

Authorizations

X-Api-Key
string
header
required

Your API key for authentication. Get your API key from the PGAI dashboard.

Path Parameters

company_id
string
required

Company ID (UUID)

Query Parameters

include
enum<string>[]

Array of sections to include. Use ["full"] for everything or specific sections.

Available options:
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
exclude
enum<string>[]

Array of sections to exclude.

Available options:
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
sources
string

Include sources (true/false)

Response

Success

Customizable company profile with optional sections

company_id
string<uuid>
required
company_name
string
website_domain
string
hq_country_name
string | null
industry
string | null
revenue_range
string | null
employee_count_range
string | null
overview
object

Company overview section

divisions
object[]

Company divisions

key_executives
object[]
geographical_operations
object[]
swot_analysis
object[]
strategic_priorities
object[]
digital_strategies
object[]
goals
object[]
risks
object[]
competitors
object[]
industry_insights
object[]
events
object[]
custom_insights
object[]
insights_scores
object[]
territory_custom_scores
object[]