Get All Entities Paginated

​

Retrieve a paginated list of all entities.

This endpoint returns a paginated collection of entities with support for:

  • Pagination: Control page size and offset using query parameters
  • Computed Fields: Choose the level of computed fields to include
  • Sorting: Results can be sorted by various fields

Args: params: Pagination parameters (page, size, etc.) computed_fields: Level of computed fields to include (none, minimal, all) user: Authenticated user information

Returns: Paginated response containing: - items: List of entities for the current page - total: Total number of entities available - page: Current page number - size: Number of items per page - pages: Total number of pages

Raises: HTTPException: - 401: Authentication required - 403: Insufficient permissions - 500: Internal server error

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.

  • page
    Type: integer
    min:  
    1

    Integer numbers.

  • size
    Type: integer
    min:  
    1
    max:  
    100

    Integer numbers.

Responses

  • application/json
  • application/json
Request Example for get/all
curl 'https://crm.dreamhub.ai/api/v1/users/all?computed_fields=minimal&include_additionals=false&page=1&size=50' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "users": [
    {
      "lastName": "Smith",
      "displayName": "John Smith",
      "department": 1,
      "areaOfResponsibility": 1,
      "email": "john.smith@company.com",
      "role": 1,
      "jobTitle": "Account Executive",
      "userLanguage": "en",
      "avatarUrl": "https://example.com/avatars/user123.jpg",
      "groupIds": [
        "g-sales",
        "g-enterprise"
      ],
      "quotaPlan": 1,
      "managerId": "u-manager123",
      "timezone": "America/New_York",
      "firstName": "John",
      "status": 1,
      "lastLoginAt": "2024-01-15T10:30:00Z",
      "id": "u-johs-f47ac10b",
      "createdAt": "2026-09-29T00:03:31.393Z",
      "directReports": [
        "string"
      ],
      "roleName": "string",
      "departmentName": "string",
      "areaOfResponsibilityName": "string",
      "additionalProperty": "anything"
    }
  ],
  "total": 0,
  "page": 1,
  "size": 1,
  "pages": 0
}

Successful Response