Skip to main content
GET
List App Installations

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Query Parameters

account_id
string

Only return installations on this account, prefixed biz_.

app_id
string

Only return installations of this app, prefixed app_. Pass your own app's ID to list the accounts that installed it.

view_type
enum<string>

Only return installations of apps that have this view, such as dashboard for apps shown in a business's dashboard.

Available options:
hub,
discover,
dash,
dashboard,
analytics,
skills,
openapi
external_id
string

Only return the installation with this external_id, the installed app's own identifier for it. Only the app and its developer can filter by it.

created_before
string

Only return installations created before this ISO 8601 timestamp.

created_after
string

Only return installations created after this ISO 8601 timestamp.

first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Required range: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

order
enum<string>
default:created_at

Field to sort installations by. name sorts by app name, and only when listing the apps installed on one account.

Available options:
created_at,
name
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

app installations listed

data
object[]
required
page_info
object
required