Get Company Profile

Read one company profile: jurisdictions, industry, regulation and signatories.

GET /api/v1/company-profiles/{profile_id}

cURL

curl "https://api.wordsmith.ai/api/v1/company-profiles/3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "id": "3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648",
  "name": "Northwind Logistics Ltd",
  "address": "12 Harbour Street, Bristol BS1 4RN, United Kingdom",
  "registration_number": "09876543",
  "tax_number": "GB123456789",
  "jurisdictions": ["England & Wales", "Ireland"],
  "industry": ["Logistics", "Freight forwarding"],
  "preferred_signatories": ["Sarah Collins, General Counsel", "Mark Ellis, CFO"],
  "organization_type": "private",
  "ownership": "pe_backed",
  "is_part_of_group": true,
  "is_regulated": false,
  "regulatory_details": null,
  "is_gdpr_applicable": true,
  "data_storage_locations": "AWS eu-west-1 (Ireland)",
  "business_description": "Road and sea freight across the UK and Ireland for retail and manufacturing clients.",
  "target_customer_profiles": ["Mid-size retailers", "Manufacturers"],
  "additional_info": "We sign on our own paper where possible."
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Returns one company profile. An organisation can keep several, for example one per group company. Agents read it as context when they review, draft and answer questions: where you operate, what you do, how you are regulated and who signs for you.

Read it before you change it with Update Company Profile.

Path parameters

profile_id · string · required

The profile id, from List Company Profiles.

Authentication

Requires an API key, or an OAuth token with directory:read.

Response

Returns 200 with the company profile. Fields nobody has filled in are null, or [] for lists. is_part_of_group, is_regulated and is_gdpr_applicable default to false.

cURL

curl "https://api.wordsmith.ai/api/v1/company-profiles/3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here"

Response

{
  "id": "3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648",
  "name": "Northwind Logistics Ltd",
  "address": "12 Harbour Street, Bristol BS1 4RN, United Kingdom",
  "registration_number": "09876543",
  "tax_number": "GB123456789",
  "jurisdictions": ["England & Wales", "Ireland"],
  "industry": ["Logistics", "Freight forwarding"],
  "preferred_signatories": ["Sarah Collins, General Counsel", "Mark Ellis, CFO"],
  "organization_type": "private",
  "ownership": "pe_backed",
  "is_part_of_group": true,
  "is_regulated": false,
  "regulatory_details": null,
  "is_gdpr_applicable": true,
  "data_storage_locations": "AWS eu-west-1 (Ireland)",
  "business_description": "Road and sea freight across the UK and Ireland for retail and manufacturing clients.",
  "target_customer_profiles": ["Mid-size retailers", "Manufacturers"],
  "additional_info": "We sign on our own paper where possible."
}

Errors

Status	error_code	When
403	insufficient_scope	The OAuth token does not hold directory:read.
404	resource_not_found	No company profile in your organisation has this id, or the caller cannot read it. An admin creates profiles in Settings.