# List all events ``` GET https://api.freemius.com/v1/products/{product_id}/installs/{install_id}/events.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 event collection related to a product install. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-installations-list-events-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-list-events-param-path-install-id "Direct link to install_id")required The ID of the install. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **count** integer[](#param-property-installations-list-events-param-query-count "Direct link to count") **Default value: **`25` The number of records to return. **Possible values:** `>= 1` and `<= 50` **Example: **`10` **offset** integer[](#param-property-installations-list-events-param-query-offset "Direct link to offset") **Default value: **`0` The number of records to skip before starting to return records. Default is 0. **Possible values:** `>= 0` **Example: **`10` **fields** string[](#param-property-installations-list-events-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` **type** string[](#param-property-installations-list-events-param-query-type "Direct link to type") Filter events by type string or event name. **Example: **`license.activated` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 402 * 404 Events triggered by the install. application/json **Schema** **events** object\[] * Array \[ **state**string[](#schema-property-installations-list-events-response-schema-state-string "Direct link to state") State of the event log. It essentially says whether the event was processed through the webhook or not. **Possible values:** \[`processed`, `pending`, `canceled`, `error`] **id**string\[](#schema-property-installations-list-events-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-list-events-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-list-events-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` **type**string[](#schema-property-installations-list-events-response-schema-type-string "Direct link to type") The type of event. See our documented list of the available [event types](https://freemius.com/help/documentation/marketing-automation/events-webhooks/#event_types). **Example: **`license.activated` **developer\_id**string\[](#schema-property-installations-list-events-response-schema-developer-id-string-int64 "Direct link to developer_id") The ID of the developer. **Possible values:** `>= 1` **Example: **`1234` **plugin\_id**string\[](#schema-property-installations-list-events-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: **`123456` **user\_id**string\[](#schema-property-installations-list-events-response-schema-user-id-string-int64 "Direct link to user_id")nullable The ID of the user the entity belongs to. If NULL then still not associated to any user. **Possible values:** `>= 1` **Example: **`123456` **install\_id**string\[](#schema-property-installations-list-events-response-schema-install-id-string-int64 "Direct link to install_id")nullable The ID of the installation or site the entity is associated with, a `null` value means it has not been associated with an installation yet. **Possible values:** `>= 1` **Example: **`123456` **data**[](#schema-property-installations-list-events-response-schema-data "Direct link to data")nullable The details of the triggered event. This can be a `string` showing ID of the associated entity, an `object` with additional information of the event, or array of objects. **event\_trigger**string[](#schema-property-installations-list-events-response-schema-event-trigger-string "Direct link to event_trigger") The type of trigger for the event. **Possible values:** \[`system`, `developer`, `plugin`, `user`, `install`] **Example: **`system` **process\_time**string\[](#schema-property-installations-list-events-response-schema-process-time-string-date-time "Direct link to process_time")nullable The time the event was processed. If it is `null`, the event is pending. **Example: **`2025-01-01 12:00:00` * ] 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-events-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-list-events-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-list-events-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-list-events-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-list-events-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-list-events-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-list-events-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-list-events-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-list-events-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-list-events-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-list-events-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-list-events-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-list-events-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-list-events-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 request is missing the specified argument. application/json **Schema** **path**string[](#schema-property-installations-list-events-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-list-events-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-list-events-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-list-events-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-list-events-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-list-events-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-list-events-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-list-events-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-list-events-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-installations-list-events-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-installations-list-events-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-installations-list-events-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-installations-list-events-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-list-events-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"}`