Skip to main content

Retrieve contact by lookup identifier

GET 
/v2/contacts/:lookupKey/:lookupValue

Retrieves a contact entity 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 contact 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 (company, addresses, etc.)
  • Comprehensive error handling for invalid identifiers
  • Support for complex organizational relationships

Use Cases:

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

Request​

Responses​

Entity found successfully with requested data