# List all market items

```
GET 
https://api.freemius.com/v1/products/{product_id}/installs/{install_id}/market_items.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.

***

Retrieves all market items associated with an `Install` entity.

> Market items are other products (not necessarily powered by Freemius) that are installed in the same site as the Freemius powered product.

> It is only after the user chooses to opt-in that such data is collected and sent to Freemius. Right now we only support WordPress products i.e. plugins and themes.

## Request[​](#request "Direct link to request")

### Path Parameters

* **product\_id**
  <!-- -->
  integer\<int64>[](#param-property-installations-list-market-items-param-path-product-id "Direct link to product_id")required

  The ID of the product.

  **Possible values:** `>= 1`

  **Example:<!-- -->&#x20;**`1234`

  **install\_id**
  <!-- -->
  integer\<int64>[](#param-property-installations-list-market-items-param-path-install-id "Direct link to install_id")required

  The ID of the install.

  **Possible values:** `>= 1`

  **Example:<!-- -->&#x20;**`1234`

<!-- -->

## Responses[​](#responses "Direct link to Responses")

* 200
* 400
* 401
* 404

All market items associated with the install.

application/json

**Schema**

**market\_items** <!-- -->object\[]

* Array \[

**id**string\<int64>[](#schema-property-installations-list-market-items-response-schema-id-string-int64 "Direct link to id")

The unique identifier of the entity.

**Possible values:** `>= 1`

**Example:<!-- -->&#x20;**`123456`

**created**string\<date-time>[](#schema-property-installations-list-market-items-response-schema-created-string-date-time "Direct link to created")

The date and time the entity was created, under UTC timezone.

**Example:<!-- -->&#x20;**`2025-01-01 00:00:00`

**updated**string\<date-time>[](#schema-property-installations-list-market-items-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:<!-- -->&#x20;**`2025-01-01 00:00:00`

**plugin\_id**string\<int64>[](#schema-property-installations-list-market-items-response-schema-plugin-id-string-int64 "Direct link to plugin_id")nullable

The ID of the product the entity belongs to. Null means it has not been associated with a product yet.

**Possible values:** `>= 1`

**Example:<!-- -->&#x20;**`123456`

**slug**string[](#schema-property-installations-list-market-items-response-schema-slug-string "Direct link to slug")

Product slug name.

**Example:<!-- -->&#x20;**`catwalk-reviews`

**title**string[](#schema-property-installations-list-market-items-response-schema-title-string "Direct link to title")

Products name.

**Example:<!-- -->&#x20;**`Catwalk Reviews`

**model**string[](#schema-property-installations-list-market-items-response-schema-model-string "Direct link to model")

**Default value:<!-- -->&#x20;**`free`

The business model of the product. We can only detect the model if the product is also integrated with Freemius.

**Possible values:** \[`free`, `premium`, `freemium`]

**type**string[](#schema-property-installations-list-market-items-response-schema-type-string "Direct link to type")

**Default value:<!-- -->&#x20;**`plugin`

The type of the product. Right now we only support WordPress products, i.e, plugins and themes.

**Possible values:** \[`plugin`, `theme`]

**downloads**integer[](#schema-property-installations-list-market-items-response-schema-downloads-integer "Direct link to downloads")

The number of product downloads.

> We are not updating this field yet. We plan to do it in the future.

**Example:<!-- -->&#x20;**`1000`

**installs\_count**integer[](#schema-property-installations-list-market-items-response-schema-installs-count-integer "Direct link to installs_count")

The number of product installs.

> We are not updating this field yet. We plan to do it in the future.

**Example:<!-- -->&#x20;**`1000`

**last\_release**string\<date-time>[](#schema-property-installations-list-market-items-response-schema-last-release-string-date-time "Direct link to last_release")

The date of the last product release/update.

> We are not updating this field yet. We plan to do it in the future.

**Example:<!-- -->&#x20;**`2025-01-01 00:00:00`

**newest\_version**string[](#schema-property-installations-list-market-items-response-schema-newest-version-string "Direct link to newest_version")

The version number of the latest release/update.

**Example:<!-- -->&#x20;**`1.0.0`

* ]

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-list-market-items-response-schema-path-string "Direct link to path")

The API request path.

**Example:<!-- -->&#x20;**`:/products/product_id/users.json`

**error** <!-- -->object

This object contains the error details.

**type**string[](#schema-property-installations-list-market-items-response-schema-type-string "Direct link to type")

The type of the error encountered by the server.

**Example:<!-- -->&#x20;**`UnauthorizedAccess`

**message**string[](#schema-property-installations-list-market-items-response-schema-message-string "Direct link to message")

The descriptive error message.

**Example:<!-- -->&#x20;**`Some error has occured.`

**code**string[](#schema-property-installations-list-market-items-response-schema-code-string "Direct link to code")

The error code.

**Example:<!-- -->&#x20;**`unauthorized_access`

**http**integer[](#schema-property-installations-list-market-items-response-schema-http-integer "Direct link to http")

The HTTP status code returned by the server.

**Example:<!-- -->&#x20;**`401`

**timestamp**string[](#schema-property-installations-list-market-items-response-schema-timestamp-string "Direct link to timestamp")

Current timestamp.

**Example:<!-- -->&#x20;**`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\***&#x61;ny[](#schema-property-installations-list-market-items-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:<!-- -->&#x20;**`{"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-list-market-items-response-schema-path-string "Direct link to path")

The API request path.

**Example:<!-- -->&#x20;**`:/products/product_id/users.json`

**error** <!-- -->object

This object contains the error details.

**type**string[](#schema-property-installations-list-market-items-response-schema-type-string "Direct link to type")

The type of the error encountered by the server.

**Example:<!-- -->&#x20;**`UnauthorizedAccess`

**message**string[](#schema-property-installations-list-market-items-response-schema-message-string "Direct link to message")

The descriptive error message.

**Example:<!-- -->&#x20;**`Some error has occured.`

**code**string[](#schema-property-installations-list-market-items-response-schema-code-string "Direct link to code")

The error code.

**Example:<!-- -->&#x20;**`unauthorized_access`

**http**integer[](#schema-property-installations-list-market-items-response-schema-http-integer "Direct link to http")

The HTTP status code returned by the server.

**Example:<!-- -->&#x20;**`401`

**timestamp**string[](#schema-property-installations-list-market-items-response-schema-timestamp-string "Direct link to timestamp")

Current timestamp.

**Example:<!-- -->&#x20;**`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\***&#x61;ny[](#schema-property-installations-list-market-items-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:<!-- -->&#x20;**`{"beautify":true,"format":"json"}`

The requested resource was not found.

application/json

**Schema**

**path**string[](#schema-property-installations-list-market-items-response-schema-path-string "Direct link to path")

The API request path.

**Example:<!-- -->&#x20;**`:/products/product_id/users.json`

**error** <!-- -->object

This object contains the error details.

**type**string[](#schema-property-installations-list-market-items-response-schema-type-string "Direct link to type")

The type of the error encountered by the server.

**Example:<!-- -->&#x20;**`UnauthorizedAccess`

**message**string[](#schema-property-installations-list-market-items-response-schema-message-string "Direct link to message")

The descriptive error message.

**Example:<!-- -->&#x20;**`Some error has occured.`

**code**string[](#schema-property-installations-list-market-items-response-schema-code-string "Direct link to code")

The error code.

**Example:<!-- -->&#x20;**`unauthorized_access`

**http**integer[](#schema-property-installations-list-market-items-response-schema-http-integer "Direct link to http")

The HTTP status code returned by the server.

**Example:<!-- -->&#x20;**`401`

**timestamp**string[](#schema-property-installations-list-market-items-response-schema-timestamp-string "Direct link to timestamp")

Current timestamp.

**Example:<!-- -->&#x20;**`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\***&#x61;ny[](#schema-property-installations-list-market-items-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:<!-- -->&#x20;**`{"beautify":true,"format":"json"}`
