Map Kruncher Objects to External Providers

This endpoint allows mapping between Kruncher objects like person, company, and opportunity and external providers. This mapping is essential for integrating with third-party systems.

Create Mapping

URL: POST {{baseUrl}}/api/integration/map

Input

{
  "entityType": "person",      // Options: "person", "company", "opportunity"
  "provider": "affinity",      // The external provider to map to
  "externalId": "ex1234567891", // ID used by the external provider
  "kruncherId": "kr1234567891"  // ID used internally by Kruncher
}

⸻

Get All Mappings for a Specific Customer

This endpoint returns all mappings of Kruncher objects to external providers for a specific customer.

Endpoint

URL: GET {{baseUrl}}/api/integration/map/all

Response Structure

The response includes metadata and data fields providing details about each mapping:

• metadata:
  • code: Status code of the response (e.g., 1000 for success).
  • title: A short description of the status (e.g., “Successful”).
  • description: Additional information (usually empty).
• data: An array of mapping objects, each containing:
  • id: Unique identifier of the mapping.
  • entityType: Type of Kruncher entity (e.g., “person”).
  • provider: The external provider.
  • kruncherId: Kruncher’s internal ID.
  • externalId: The external system’s ID.
  • createdAt: Timestamp when the mapping was created.
  • updatedAt: Timestamp when the mapping was last updated.
  • customerId: Unique identifier of the customer.

Note: No pagination details are provided in the response for this specific endpoint.

Headers • Authorization: Your apiKey is required for authentication.