get_crm_context_by

Name: get_crm_context_by_id

Description: Retrieves CRM context information by context ID, including context name, type, system information, and associated metadata. This endpoint returns essential context details for understanding CRM objects like accounts, contacts, opportunities, and other CRM entities. The response includes context identification, display name, object type, and system identifiers used for cross-system integration and data correlation.

Schema

{
  "type": "object",
  "properties": {
    "typeHint": {
      "type": "string",
      "description": "The type hint indicating the kind of CRM object being requested (e.g., 'account', 'contact', 'opportunity', 'lead'). This parameter helps the API determine the correct endpoint and processing logic for the specific CRM context type."
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the CRM context object (e.g., account ID, contact ID, opportunity ID). This ID is specific to the CRM system and is used to retrieve detailed context information for AI agent operations and cross-system correlations."
    },
    "systemType": {
      "type": "string",
      "description": "Required parameter specifying the CRM system type (e.g., 'salesforce', 'dynamics', 'hubspot'). This parameter ensures proper system-specific processing and context retrieval."
    },
    "systemId": {
      "type": "string",
      "description": "Required parameter specifying the unique system identifier of the CRM instance. Used for multi-tenant or multi-org scenarios where the same context ID might exist across different CRM instances."
    }
  },
  "required": [
    "typeHint",
    "id",
    "systemType",
    "systemId"
  ]
}

{
  "type": "object",
  "properties": {
    "crmContext": {
      "type": "object",
      "properties": {
        "contextId": {
          "type": "string",
          "description": "The unique identifier of the CRM context object."
        },
        "name": {
          "type": "string",
          "description": "The display name of the CRM context (e.g., account name, contact name, opportunity title)."
        },
        "type": {
          "type": "string",
          "description": "The type of CRM object (e.g., 'Account', 'Contact', 'Opportunity', 'Lead')."
        },
        "systemId": {
          "type": "string",
          "description": "The unique identifier of the CRM system instance."
        },
        "systemType": {
          "type": "string",
          "description": "The type of CRM system (e.g., 'Salesforce', 'Dynamics', 'HubSpot')."
        }
      },
      "required": [
        "contextId",
        "name",
        "type"
      ]
    }
  },
  "required": [
    "crmContext"
  ]
}