List all app installs

Changed on

Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.

get/v1/apps/installs

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/apps/installs
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

accountstring

Only return installs made by this account. Only useful to app developers and embedding platforms, whose lists span the accounts that installed their app.

appstring

Only return installs for the app specified by this app ID.

approval_requiredboolean

Only return installs whose installer must authorize pending permissions, content security policy entries, or endpoints.

channel'private_live' | 'private_test' | 'public' | 'testing'

Only return installs in the distribution channel specified by this channel name.

OR
integer

Only return app installs that were created during the given date interval.

created_bystring

Only return installs created by the embedding platform specified by this account ID.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

status'install_failed' | 'installed' | 'installing' | 'uninstall_failed' | 'uninstalling'

Only return installs with the given status.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes

  • 8b5c2f03d4cdRevision changes
    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.