Skip to main content

Retrieve company by lookup identifier

GET 
/v2/companies/:lookupKey/:lookupValue

Retrieves a company using flexible lookup methods. Supports both internal system IDs and external source identifiers for seamless integration with multiple business systems.

Lookup Methods:

  • ID: Use internal company ID (numeric)
  • SOURCE_ID: Use external system identifier (string/numeric)

Features:

  • Flexible identifier support for different integration scenarios
  • Optional source filtering for multi-source environments
  • Data expansion capabilities for related entities (contacts, addresses, etc.)
  • Comprehensive error handling for invalid identifiers
  • Support for complex organizational hierarchies

Use Cases:

  • Company profile retrieval by internal ID
  • Integration with external ERP/CRM systems
  • Company lookup during business operations
  • Data synchronization between platforms
  • Organizational structure analysis

Request​

Responses​

Entity found successfully with requested data