# Retrieve an install ``` GET https://api.freemius.com/v1/products/{product_id}/installs/{install_id}.json ``` #### Auth:Bearer TokenSCOPE: PRODUCT Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need. 1. Go to the [Freemius Developer Dashboard](https://dashboard.freemius.com/). 2. Open the Settings page of the relevant product. 3. Click the API & Keys tab. 4. Copy the API Bearer Authorization Token from the UI. *** Retrieve the details related to the product install. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-installations-retrieve-install-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` **install\_id** integer\[](#param-property-installations-retrieve-install-param-path-install-id "Direct link to install_id")required The ID of the install. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **fields** string[](#param-property-installations-retrieve-install-param-query-fields "Direct link to fields") Comma separated list of fields to return in the response. If not specified, all fields are returned. **Example: **`id,name,slug` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 404 The install details. application/json **Schema** **secret\_key**string[](#schema-property-installations-retrieve-install-response-schema-secret-key-string "Direct link to secret_key") The secret key associated with the entity for authorization. **Example: **`sk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **public\_key**string[](#schema-property-installations-retrieve-install-response-schema-public-key-string "Direct link to public_key") The public key associated with the entity for authorization. **Example: **`pk_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6` **id**string\[](#schema-property-installations-retrieve-install-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-installations-retrieve-install-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-installations-retrieve-install-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **site\_id**string\[](#schema-property-installations-retrieve-install-response-schema-site-id-string-int64 "Direct link to site_id") The ID of the site. **Example: **`1234` **plugin\_id**string\[](#schema-property-installations-retrieve-install-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **user\_id**string\[](#schema-property-installations-retrieve-install-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **url**string[](#schema-property-installations-retrieve-install-response-schema-url-string "Direct link to url")nullable The site URL. **Example: **`https://example.com` **title**string[](#schema-property-installations-retrieve-install-response-schema-title-string "Direct link to title")nullable The site title. **Example: **`Catwalk Designs` **version**string[](#schema-property-installations-retrieve-install-response-schema-version-string "Direct link to version") The Product version. **Example: **`1.0.0` **plan\_id**string\[](#schema-property-installations-retrieve-install-response-schema-plan-id-string-int64 "Direct link to plan_id") The ID of the plan associated with the product that the install has a license activation. If `null` it means the install is using the free plan. **Possible values:** `>= 1` **Example: **`1234` **license\_id**string\[](#schema-property-installations-retrieve-install-response-schema-license-id-string-int64 "Direct link to license_id")nullable The ID of the license associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **trial\_plan\_id**string\[](#schema-property-installations-retrieve-install-response-schema-trial-plan-id-string-int64 "Direct link to trial_plan_id") The ID of the trial license associated to the product. If this is not a trial, this will be `null`. **Possible values:** `>= 1` **Example: **`1234` **trial\_ends**string\[](#schema-property-installations-retrieve-install-response-schema-trial-ends-string-date-time "Direct link to trial_ends")nullable The product trial license expiry date. If this is not a trial, this will be null. **Example: **`2025-01-01 00:00:00` **subscription\_id**string\[](#schema-property-installations-retrieve-install-response-schema-subscription-id-string-int64 "Direct link to subscription_id")nullable The ID of the subscription associated with the entity. **Possible values:** `>= 1` **Example: **`123456` **gross**number\[](#schema-property-installations-retrieve-install-response-schema-gross-number-float "Direct link to gross") The gross amount the install has spent on the product. This includes one time purchase, or subscriptions and renewals. **Example: **`100` **country\_code**string[](#schema-property-installations-retrieve-install-response-schema-country-code-string "Direct link to country_code")nullable The [ISO 3166-1 alpha 2](http://www.wikiwand.com/en/ISO_3166-1_alpha-2) two-letter country code associated with the entity. **Example: **`us` **language**string[](#schema-property-installations-retrieve-install-response-schema-language-string "Direct link to language")nullable The language specified for the product install. **Example: **`en-GB` **platform\_version**string[](#schema-property-installations-retrieve-install-response-schema-platform-version-string "Direct link to platform_version")nullable The platform version (e.g WordPress version). **Example: **`1.0.0` **sdk\_version**string[](#schema-property-installations-retrieve-install-response-schema-sdk-version-string "Direct link to sdk_version")nullable The Freemius SDK version. Only relevant for WordPress products using the Freemius [WP SDK](https://freemius.com/help/documentation/wordpress-sdk/). **Example: **`1.2.2` **programming\_language\_version**string[](#schema-property-installations-retrieve-install-response-schema-programming-language-version-string "Direct link to programming_language_version")nullable The programming language version (e.g PHP version). **Example: **`5.6` **is\_active**boolean[](#schema-property-installations-retrieve-install-response-schema-is-active-boolean "Direct link to is_active") If the product is actively installed on the site. **is\_disconnected**boolean[](#schema-property-installations-retrieve-install-response-schema-is-disconnected-boolean "Direct link to is_disconnected") If the product is disconnected on the site. **is\_premium**boolean[](#schema-property-installations-retrieve-install-response-schema-is-premium-boolean "Direct link to is_premium") If the install using the premium code. Relevant only for WP Products. **is\_uninstalled**boolean[](#schema-property-installations-retrieve-install-response-schema-is-uninstalled-boolean "Direct link to is_uninstalled") If the product is uninstalled on the site. **is\_locked**boolean[](#schema-property-installations-retrieve-install-response-schema-is-locked-boolean "Direct link to is_locked") If the product is locked on the site. **source**number[](#schema-property-installations-retrieve-install-response-schema-source-number "Direct link to source") The source of the migration data. To get support migrating from other platform please see our [documentation](https://freemius.com/help/documentation/migration/). * `0` - Freemius * `1` - Other * `2` - Easy Digital Downloads (EDD) * `3` - WooCommerce (WC) * `4` - Rating Widget * `5` - Gumroad * `6` - CodeCanyon * `7` - ThemeForest * `8` - AppSumo * `9` - SendOwl * `10` - WHMCS * `11` - Lemon Squeezy **Possible values:** \[`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`] **upgraded**string\[](#schema-property-installations-retrieve-install-response-schema-upgraded-string-date-time "Direct link to upgraded")nullable Time when the product was upgraded to the current version. If never upgraded since the initial installation, this will be `null`. **Example: **`2025-01-01 00:00:00` **last\_seen\_at**string\[](#schema-property-installations-retrieve-install-response-schema-last-seen-at-string-date-time "Direct link to last_seen_at")nullable The last time the product was used on the site. **Example: **`2025-01-01 00:00:00` **last\_served\_update\_version**string[](#schema-property-installations-retrieve-install-response-schema-last-served-update-version-string "Direct link to last_served_update_version")nullable The last product version update used on the site. If not updated, this will be null. **Example: **`1.2.2` **is\_beta**boolean[](#schema-property-installations-retrieve-install-response-schema-is-beta-boolean "Direct link to is_beta") Whether the install is participating in the beta program. Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-installations-retrieve-install-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-install-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-install-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-install-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-install-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-install-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-install-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` Unauthorized access error. The request requires [authentication](https://freemius.com/help/api/#bearer-token-authentication) but was not provided or the provided authentication does not satisfy the required permissions. application/json **Schema** **path**string[](#schema-property-installations-retrieve-install-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-install-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-install-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-install-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-install-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-install-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-install-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The requested resource was not found. application/json **Schema** **path**string[](#schema-property-installations-retrieve-install-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-installations-retrieve-install-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-retrieve-install-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-retrieve-install-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-retrieve-install-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-retrieve-install-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-installations-retrieve-install-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}`