Get Entities By Ids

​

Retrieve multiple entities by their IDs in a single request.

This endpoint allows fetching multiple entities efficiently by providing a comma-separated list of entity IDs. Useful for bulk operations and reducing the number of API calls.

Args: ids: Comma-separated list of entity IDs (e.g., "id1,id2,id3") computed_fields: Level of computed fields to include user: Authenticated user information response: HTTP response object for status code modification

Returns: Dictionary containing: - entities: List of found entities - found_count: Number of entities successfully retrieved - requested_count: Total number of IDs requested

Note: - Returns HTTP 206 (Partial Content) if some entities are not found - Returns HTTP 200 if all requested entities are found - Missing entities are silently omitted from results

Raises: HTTPException: - 400: Invalid ID format or empty ID list - 401: Authentication required - 403: Insufficient permissions - 404: No entities found for any of the provided IDs - 500: Internal server error

Query Parameters

  • ids
    Type: string
    required

    Comma-separated list of IDs

  • 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/
curl 'https://crm.dreamhub.ai/api/v1/users/?ids=&computed_fields=minimal&include_additionals=false' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "additionalProperty": "anything"
}

Successful Response