> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a contact's Salesforce CRM panel

> Get a contact's Salesforce CRM panel — The full Salesforce view of one OpenCX contact: the matched Contact or Lead, its account, opportunities, past cases, and the organization's…



## OpenAPI

````yaml get /salesforce-crm/contacts/{contactId}
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /salesforce-crm/contacts/{contactId}:
    get:
      summary: Get a contact's Salesforce CRM panel
      description: >-
        The full Salesforce view of one OpenCX contact: the matched Contact or
        Lead, its account, opportunities, past cases, and the organization's
        configured custom objects. `lookup_status` distinguishes a confirmed
        no-match (`none`) from Salesforce being unreachable (`failed`) — treat
        `failed` as unknown, never as absence.
      operationId: getSalesforceCrmContact
      parameters:
        - schema:
            type: string
          in: path
          name: contactId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerSalesforceCrmContactResponseDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    ConsumerSalesforceCrmContactResponseDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/ConsumerSalesforceCrmContactResponseDto'
      type: object
      properties:
        consumer_id:
          type: string
        consumer_email:
          type: string
        consumer_phone:
          type: string
        salesforce_contact:
          $ref: '#/components/schemas/SalesforceCrmContactDetailsDto'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/SalesforceCrmAccountDetailsDto'
        opportunities:
          type: array
          items:
            $ref: '#/components/schemas/SalesforceCrmOpportunityDetailsDto'
        previous_cases:
          type: array
          items:
            $ref: '#/components/schemas/SalesforceCrmCaseDetailsDto'
        custom_objects:
          type: array
          items:
            $ref: '#/components/schemas/SalesforceCrmCustomObjectSectionDto'
        found_in_salesforce:
          type: boolean
        lookup_status:
          type: string
          enum:
            - found
            - none
            - failed
        message:
          type: string
      required:
        - consumer_id
        - found_in_salesforce
        - lookup_status
        - message
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    SalesforceCrmContactDetailsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmContactDetailsDto'
      type: object
      properties:
        id:
          type: string
        salesforce_record_id:
          type: string
        record_type:
          type: string
          enum:
            - Contact
            - Lead
        email:
          type: string
        phone:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        company:
          type: string
        salesforce_data: {}
        cached_at:
          type: string
        salesforce_link:
          type: string
      required:
        - id
        - salesforce_record_id
        - record_type
        - cached_at
        - salesforce_link
      additionalProperties: false
    SalesforceCrmAccountDetailsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmAccountDetailsDto'
      type: object
      properties:
        salesforce_account_id:
          type: string
        name:
          type: string
        website:
          type: string
        industry:
          type: string
        number_of_employees:
          type: string
        annual_revenue:
          type: string
        billing_city:
          type: string
        billing_state:
          type: string
        billing_country:
          type: string
        salesforce_data: {}
        salesforce_link:
          type: string
      required:
        - salesforce_account_id
        - salesforce_link
      additionalProperties: false
    SalesforceCrmOpportunityDetailsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmOpportunityDetailsDto'
      type: object
      properties:
        salesforce_opportunity_id:
          type: string
        name:
          type: string
        stage_name:
          type: string
        amount:
          type: string
        close_date:
          type: string
        is_closed:
          type: boolean
        is_won:
          type: boolean
        salesforce_data: {}
        salesforce_link:
          type: string
      required:
        - salesforce_opportunity_id
        - salesforce_link
      additionalProperties: false
    SalesforceCrmCaseDetailsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmCaseDetailsDto'
      type: object
      properties:
        salesforce_case_id:
          type: string
        case_number:
          type: string
        subject:
          type: string
        status:
          type: string
        priority:
          type: string
        origin:
          type: string
        created_date:
          type: string
        last_modified_date:
          type: string
        salesforce_data: {}
        salesforce_link:
          type: string
      required:
        - salesforce_case_id
        - salesforce_link
      additionalProperties: false
    SalesforceCrmCustomObjectSectionDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmCustomObjectSectionDto'
      type: object
      properties:
        object_api_name:
          type: string
        label:
          type: string
        records:
          type: array
          items:
            $ref: '#/components/schemas/SalesforceCrmCustomObjectRecordDto'
      required:
        - object_api_name
        - label
      additionalProperties: false
    SalesforceCrmCustomObjectRecordDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/SalesforceCrmCustomObjectRecordDto'
      type: object
      properties:
        id:
          type: string
        values:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type:
              - string
              - number
              - boolean
              - 'null'
        salesforce_link:
          type: string
      required:
        - id
        - values
        - salesforce_link
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.