company-profile

Get Company Profiles

Get company profiles the current user has access to in the ACTIVE organization.

RBAC Logic:

  • Org owners/admins see ALL profiles in the active organization
  • Members see only profiles they have explicit CompanyProfileAccess to
  • Only org admins/owners can query archived or deleted profiles or all profiles (no status filter)

Multi-org Support:

  • Uses X-Organization-Id header to determine which organization's profiles to return
  • Only returns profiles from the active organization
  • Validates user has access to the organization via get_active_organization_id dependency
get/api/company-profile/

Request

  • Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepomo.ai/api/company-profile/
  • Auth: HTTP bearer

Query parameters

status'active' | 'archived' | 'deleted'

Lifecycle status for a company profile.

Filter profiles by status (active, archived, deleted). If not specified, returns all profiles. Only org admins can view non-active profiles.

scope'active_org' | 'my_accessible'

Optional scoped list query. 'active_org' returns active profiles in the active organization for admins. 'my_accessible' returns active profiles visible to the current user.

force_refreshboolean

Bypass the shared response cache

Headers

X-Organization-Idstring nullable

Response

Successful Response

namestring nullable
descriptionstring nullable
company_linksstring[] nullable
brand_attributesobject nullable
categoriesunknown
primary_business_modelstring nullable
secondary_business_modelsstring[] nullable
business_model_metadataobject nullable
additional_metadataobject nullable
competitive_analysisobject nullable
recommended_marketing_strategyobject nullable
marketing_goalstring nullable
marketing_campaign_goalstring nullable
campaign_custom_instructionsstring nullable
average_monthly_campaign_budgetnumber nullable
average_monthly_campaign_budget_currencystring nullable
document_summariesobject nullable
operating_regionsstring[] nullable
default_scheduling_timezonestring nullable

Default IANA timezone used when creating a schedule.

logo_imagestring nullable
logo_urlstring nullable
is_completedboolean nullable
statusstring nullable
idstring nullable required
organization_idstring nullable required
creator_idstring nullable required
created_atstring nullable required
updated_atstring nullable required
category_attributesunknown
marketing_profile_completedboolean
onboarding_status'not_started' | 'queued' | 'running' | 'completed' | 'incomplete' | 'failed'

Changes

No recorded changes to this operation across all 1 revision of this API.