Get Entity By Id

​

Retrieve a specific entity by its unique identifier.

This endpoint fetches detailed information for a single entity using its ID. The response includes all entity fields plus any requested computed fields.

Args: entity_id: Unique identifier of the entity to retrieve computed_fields: Level of computed fields to include: - none: No computed fields (fastest response, only base entity data) - minimal: Essential computed fields only (default, balanced performance - includes key metrics like counts, summaries, and frequently accessed calculations) - all: All available computed fields (slowest response, complete data with all aggregations and calculations) user: Authenticated user information

Returns: Complete entity data including: - All base entity fields - Computed fields based on the specified level - Related entity references - Timestamps and metadata

Raises: HTTPException: - 400: Invalid entity ID format - 401: Authentication required - 403: Insufficient permissions to access this entity - 404: Entity not found - 500: Internal server error

Path Parameters

  • entity_id
    Type: string
    required

Query Parameters

  • computed_fields
    Type: enum

    Level of computed fields to include: none (fastest, base data only), minimal (default, includes essential computed fields like counts and summaries), or all (slowest, includes all computed fields)

    Level of computed fields to include in API responses.

    Attributes: NONE: No computed fields included (fastest response, only base entity data) MINIMAL: Essential computed fields only (balanced performance and data) ALL: All available computed fields (complete data, slower response)

    values
    • none = NONE

      No computed fields included (fastest response, only base entity data)

    • minimal = MINIMAL

      Essential computed fields only (balanced performance and data)

    • all = ALL

      All available computed fields (complete data, slower response)

  • include_additionals
    Type: boolean

    Whether to include additional fields from the additional fields tab.

Responses

  • application/json
  • application/json
Request Example for get/{entity_id}
curl 'https://crm.dreamhub.ai/api/v1/deals/{entity_id}?computed_fields=minimal&include_additionals=false' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "name": "Acme Corp - Enterprise License Q1 2024",
  "managedBy": "550e8400-e29b-41d4-a716-446655440000",
  "companyId": "550e8400-e29b-41d4-a716-446655440001",
  "contactId": "550e8400-e29b-41d4-a716-446655440002",
  "leadId": "550e8400-e29b-41d4-a716-446655440003",
  "status": "active",
  "stage": 3,
  "movedToStageAt": "2024-01-15T10:30:00Z",
  "expectedCloseAt": "2024-03-31T23:59:59Z",
  "closedAt": "2024-03-28T14:30:00Z",
  "dealValueAmount": 125000,
  "arr": 50000,
  "mrr": 4166.67,
  "arrLocal": 50000,
  "mrrLocal": 4166.67,
  "probability": 75,
  "techEvaluationStatus": 1,
  "qualificationScore": 85.5,
  "aeConfidenceLevel": 1,
  "aiAssignedProbability": 78.3,
  "closedLostReason": 3,
  "closedLostReasonText": "Customer chose competitor due to lower pricing",
  "manuallyAddedPeople": [
    "550e8400-e29b-41d4-a716-446655440004",
    "550e8400-e29b-41d4-a716-446655440005"
  ],
  "manuallyAddedPartnerContacts": [
    "ptc-abc123",
    "ptc-def456"
  ],
  "contractStartDate": "2024-04-01T00:00:00Z",
  "contractEndDate": "2025-03-31T23:59:59Z",
  "optOutDate": "2024-06-30T23:59:59Z",
  "contractTotalAmount": 150000,
  "amountBreakdownByPeriod": [
    {
      "amount": 37500,
      "period": "2024-Q1"
    },
    {
      "amount": 37500,
      "period": "2024-Q2"
    }
  ],
  "autoRenewal": true,
  "licenseId": "ENT-2024-001",
  "productId": "PROD-ENTERPRISE",
  "licensesInDeal": 50,
  "potentialLicensesInCompany": 200,
  "implementationCost": 15000,
  "trainingCost": 5000,
  "uploadContracts": {
    "contract_v1.pdf": {
      "size": 1024000,
      "uploaded_at": "2024-01-15T10:00:00Z"
    }
  },
  "annualContractValue": 125000,
  "totalContractValue": 375000,
  "currency": "USD",
  "contractId": "CONTRACT-2024-001",
  "partnerId": "ptn-acme-550e8400",
  "partnerContactId": "ptc-jane-550e8400",
  "automaticallyAddedPeople": [
    "string"
  ],
  "automaticallyAddedPartnerContacts": [
    "string"
  ],
  "lastModifiedBy": "string",
  "id": "d-log-f47ac10b",
  "createdAt": "2026-09-29T00:01:38.146Z",
  "lastActivity": "2026-09-29T00:01:38.146Z",
  "openForDays": 1,
  "allDealPeople": [
    "string"
  ],
  "allDealPartnerContacts": [
    "string"
  ],
  "percentageOfMappedContacts": 1,
  "percentageFromOwnerPipelineArr": 1,
  "percentageFromOwnerPipelineMrr": 1,
  "daysInStage": 1,
  "committedArr": 1,
  "committedMrr": 1,
  "keyStakeholdersMappingScore": 1,
  "keyStakeholdersMappingText": "string",
  "championsMappingScore": 1,
  "championsMappingText": "string",
  "qualificationText": "string",
  "stakeholdersApprovalText": "string",
  "closedLostReasonName": "string",
  "companyName": "string",
  "productName": "string",
  "alerts": [
    {
      "additionalProperty": "anything"
    }
  ],
  "hasNextSteps": true,
  "serviceCount": 1,
  "closingQuarter": "string",
  "additionalProperty": "anything"
}

Successful Response