Skip to main content
GET
Get customizable company profile

Authorizations

x-api-key
string
header
required

Your API key for authentication. Get your API key from the PG:AI dashboard under Settings > API Keys.

Path Parameters

company_id
string
required

Company ID (UUID)

Query Parameters

include
enum<string>[]

Comma-separated list of sections to include. Pass full to return every section.

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>[]

Comma-separated list of sections to omit from the response.

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
boolean
default:false

When true, include source citations alongside the profile content.

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[]