For the complete documentation index, see llms.txt. This page is also available as Markdown.

List applications

Lists applications with filters, sorting and offset pagination

List Applications

get

Retrieve a paginated list of canonical applications with aggregates

Authorizations
AuthorizationstringRequired

Harmony access key, sent as Authorization: AccessKey <your-key>. Create keys in Settings > Access Keys. The tenant is resolved from the key.

Query parameters
employee_idstring · nullableOptional

Filter applications by employee access

device_idstring · nullableOptional

Filter applications by device ID (requires source)

vendorstring[] · nullableOptional

Filter by vendor name

app_owner_idsstring[] · nullableOptional

Filter by app owner employee IDs

budget_approver_idsstring[] · nullableOptional

Filter by budget approver employee IDs

it_approver_idsstring[] · nullableOptional

Filter by IT approver employee IDs

searchstring · nullableOptional

Search in name, display_name, description, or vendor

sort_bystring · enumOptional

Field to sort by

Default: namePossible values:
sort_orderstring · enumOptional

Sort order

Default: ascPossible values:
custom_field_sort_bystring · nullableOptional

Qualified field ref (config_id:field_id) to sort by. Takes precedence over sort_by.

custom_field_sort_typestring · enum · nullableOptional

Field type hint for sort cast ('number' or 'text').

Possible values:
custom_field_filtersstring · nullableOptional

JSON filter by custom field values. Structure: {config_id:field_id: [values]}

insightstring · enum · nullableOptional

Filter by insight category

Possible values:
created_afterstring · date-time · nullableOptional

Filter applications created after this datetime (ISO 8601)

include_custom_fields_configbooleanOptional

Include custom field config metadata

Default: false
limitinteger · min: 1 · max: 1000OptionalDefault: 25
offsetintegerOptionalDefault: 0
Responses
200

Successful Response

application/json
total_countintegerRequired

The total number of items available to return for this query.

get/api/v1/apps
GET /applications/api/v1/apps HTTP/1.1
Host: api.harmony.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "total_count": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "stakeholders": [
        {
          "employee_id": "text",
          "role": "APP_OWNER",
          "assigned_at": "2026-01-01T00:00:00.000Z",
          "assigned_by": "text"
        }
      ],
      "status": "DISCOVERED",
      "primary_sources": [
        "OKTA"
      ],
      "catalog_id": "text",
      "display_name": "text",
      "description": "text",
      "vendor": "text",
      "category": "SALES",
      "monthly_cost_per_user": "text",
      "is_manual": false,
      "access_request": "UNAVAILABLE",
      "statuspage_status": "NOT_MONITORED",
      "active_users": {
        "histogram": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "total": 1
      },
      "usage_trend": {
        "histogram": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "total": 1,
        "by_activity_type": {
          "ANY_ADDITIONAL_PROPERTY": {
            "histogram": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "total": 1
          }
        }
      },
      "activity_metrics": {
        "ANY_ADDITIONAL_PROPERTY": {
          "histogram": {
            "ANY_ADDITIONAL_PROPERTY": 1
          },
          "total": 1,
          "type": "unit",
          "derived_from": "text",
          "outcome_result": "text",
          "outcome_reason": "text"
        }
      },
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "custom_fields_with_config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": {
            "value": "text",
            "label": "text",
            "type": "number",
            "required": false,
            "options": [
              "text"
            ]
          }
        }
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "last_sync": "2026-01-01T00:00:00.000Z",
      "sources": [
        "text"
      ],
      "total_instances": 0,
      "total_users": 0,
      "total_licenses": 0,
      "total_used_seats": 0,
      "total_available_seats": 0,
      "total_monthly_cost": "0.00",
      "active_licenses_count": 0,
      "has_unlimited_licenses": false,
      "detected_logins": 0,
      "estimated_monthly_cost": "text",
      "is_cost_estimated": false,
      "contracts": {
        "total_contracts": 0,
        "total_contract_items": 0,
        "default_currency": "USD",
        "monthly_cost": "0.00",
        "quarterly_cost": "0.00",
        "annual_cost": "0.00"
      },
      "compliance": {
        "total_records": 0,
        "compliant_count": 0,
        "frameworks": [
          "text"
        ]
      }
    }
  ]
}

Last updated

Was this helpful?