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.
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.
The date and time the entity was created, under UTC timezone.
Example: 2025-01-01 00:00:00
updatedstring<date-time>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
plugin_idstring<int64>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: 123456
slugstring
Product slug name.
Example: catwalk-reviews
titlestring
Products name.
Example: Catwalk Reviews
modelstring
Default value: 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]
typestring
Default value: plugin
The type of the product. Right now we only support WordPress products, i.e, plugins and themes.
Possible values: [plugin, theme]
downloadsinteger
The number of product downloads.
We are not updating this field yet. We plan to do it in the future.
Example: 1000
installs_countinteger
The number of product installs.
We are not updating this field yet. We plan to do it in the future.
Example: 1000
last_releasestring<date-time>
The date of the last product release/update.
We are not updating this field yet. We plan to do it in the future.
Example: 2025-01-01 00:00:00
newest_versionstring
The version number of the latest release/update.
Example: 1.0.0
]
Bad request. The request could not be understood by the server due to malformed syntax or arguments.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
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
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 but was not provided or the provided authentication does not satisfy the required permissions.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
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
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.
Schema
pathstring
The API request path.
Example: :/products/product_id/users.json
error object
This object contains the error details.
typestring
The type of the error encountered by the server.
Example: UnauthorizedAccess
messagestring
The descriptive error message.
Example: Some error has occured.
codestring
The error code.
Example: unauthorized_access
httpinteger
The HTTP status code returned by the server.
Example: 401
timestampstring
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
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"}
We use essential cookies to enable our site to function. With your consent, we also use analytics and advertising cookies to understand how visitors interact with our site and to improve our services.
