Get a company by lookup key
GET/companies/:lookupKey/:lookupValue
Retrieve comprehensive company information using dynamic lookup keys with optional data expansion and related entity inclusion.
Key Features
- Dynamic Lookup Keys: Access companies by
id
orsourceId
+source
combination - Data Expansion: Include related data like parent companies, addresses, and financial information
- Complete Response Structure: Receive detailed company profiles with all associated metadata and relationships
- Error Handling: Clear error messages for invalid lookup keys or missing companies
Request
Responses
- 200
- 400
- 404
Get a company by lookup key - 200
Get a company by lookup key - 400 (invalid lookup key)
Get Company by lookup key - 404