Get an application

Returns a single application with aggregated usage and ownership data

Get Application

get

Retrieve a canonical application with aggregated data

Authorizations

AuthorizationstringRequired

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

Path parameters

application_idstringRequired

Query parameters

include_custom_fields_configbooleanOptional

Include custom field config metadata

Default: false

Responses

200

Successful Response

application/json

Response for single application with source instances.

idstringRequired

Unique identifier for the application

namestringRequired

Application name

statusstring · enumRequired

Application status

Possible values:

catalog_idstring · nullableOptional

ID from catalog

display_namestring · nullableOptional

Human-readable name from catalog

descriptionstring · nullableOptional

Application description from catalog

vendorstring · nullableOptional

Vendor/company name from catalog

categorystring · enum · nullableOptional

Application category from catalog

Possible values:

monthly_cost_per_userstring · nullableOptional

Monthly cost per user from catalog

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

is_manualbooleanOptional

Whether this application was manually created

Default: false

access_requeststring · enumOptional

Whether this app is available for access requests

Default: UNAVAILABLEPossible values:

statuspage_statusstring · enumOptional

Current operational status

Default: NOT_MONITOREDPossible values:

created_atstring · date-timeRequired

Creation timestamp

updated_atstring · date-timeRequired

Last update timestamp

last_syncstring · date-time · nullableOptional

Last time data was synchronized from source (computed from instances)

sourcesstring[]Optional

List of sources where this application was discovered

total_instancesintegerOptional

Total number of application instances

Default: 0

total_usersintegerOptional

Total number of users

Default: 0

total_licensesintegerOptional

Total number of licenses

Default: 0

total_used_seatsintegerOptional

Total used seats

Default: 0

total_available_seatsintegerOptional

Total available seats (-1 for unlimited)

Default: 0

total_monthly_coststringOptional

Total monthly cost

Default: 0.00Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

active_licenses_countintegerOptional

Number of active licenses

Default: 0

has_unlimited_licensesbooleanOptional

Whether any license has unlimited seats

Default: false

detected_loginsintegerOptional

Total detected logins across all instances

Default: 0

estimated_monthly_coststring · nullableOptional

Estimated cost (monthly_cost_per_user × total_users)

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

is_cost_estimatedbooleanOptional

Whether cost is estimated based on per-user pricing

Default: false

statuspage_descriptionstring · nullableOptional

Status description

statuspage_checked_atstring · date-time · nullableOptional

When status was last checked

422

Validation Error

application/json

get/api/v1/apps/{application_id}

GET /applications/api/v1/apps/{application_id} HTTP/1.1
Host: api.harmony.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "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"
    ]
  },
  "source_instances": [
    {
      "source": "text",
      "instance_id": "text"
    }
  ],
  "statuspage_description": "text",
  "statuspage_details": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "statuspage_checked_at": "2026-01-01T00:00:00.000Z"
}