/applications/summary - Get applications grouped by type

GET /applications/summary
Bearer auth

Returns applications grouped by instance_of (type) with a counter. Hierarchically authorized: the caller only sees applications on systems within their organization tree. Optionally filterable by organization_id to restrict to a specific organization. When include_hierarchy is true, also includes applications from all child organizations.

Query parameters

  • organization_id string

    Logto ID of a specific organization to filter by. Must be within the caller's hierarchy.

  • include_hierarchy boolean

    When true (and organization_id is provided), includes applications from all child organizations in the hierarchy

    Default value is false.

  • page integer

    Page number for paginating the by_type array (1-based). If omitted, all types are returned.

    Minimum value is 1.

  • page_size integer

    Number of application types per page (max 100). If omitted, all types are returned.

    Minimum value is 1, maximum value is 100.

  • sort_by string

    Field to sort by_type results by

    Values are count, created_at, or instance_of. Default value is count.

  • sort_direction string

    Sort direction

    Values are asc or desc. Default value is desc.

Responses

  • 200 application/json

    Application type summary retrieved successfully

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • total integer

        Total number of matching applications

      • by_type array[object]

        Applications grouped by type, sorted and paginated

        Application type metadata (only user-facing types are returned)

        Hide by_type attributes Show by_type attributes object
        • instance_of string

          Application type identifier (lowercase, e.g., nethvoice, webtop, mail)

        • name string

          Human-readable name of the application type (e.g., NethVoice, WebTop)

        • count integer

          Number of applications of this type

      • pagination object
        Hide pagination attributes Show pagination attributes object
        • page integer

          Current page number

          Minimum value is 1.

        • page_size integer

          Number of items per page

          Minimum value is 1, maximum value is 100.

        • total_count integer

          Total number of items

          Minimum value is 0.

        • total_pages integer

          Total number of pages

          Minimum value is 0.

        • has_next boolean

          Whether there is a next page

        • has_prev boolean

          Whether there is a previous page

        • next_page integer | null

          Next page number if available

        • prev_page integer | null

          Previous page number if available

        • sort_by string | null

          Field used for sorting

        • sort_direction string | null

          Sort direction

          Values are asc or desc.
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /applications/summary 
curl \
 --request GET 'https://api.your-domain.com/api/applications/summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "code": 200,
  "message": "application type summary retrieved successfully",
  "data": {
    "total": 130,
    "by_type": [
      {
        "instance_of": "nethvoice",
        "name": "NethVoice",
        "count": 30
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 20,
      "total_count": 156,
      "total_pages": 8,
      "has_next": true,
      "has_prev": false,
      "next_page": 2,
      "prev_page": 42,
      "sort_by": "name",
      "sort_direction": "asc"
    }
  }
}
Response examples (401) 
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403) 
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}