Skip to main content
GET
Retrieve App Installation

Autorisaties

Authorization
string
header
vereist

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.

Scopes

developer:app_installation:read
company:basic:read
developer:basic:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

App installation ID, prefixed aag_.

Respons

app installation retrieved

account
object
vereist

Account the app is installed on.

app
object
vereist

App that is installed.

created_at
string
vereist

When the app was first installed on the account, as an ISO 8601 timestamp. Installing the app again later keeps the original time.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

external_id
string | null
vereist

Your app's own identifier for this installation, such as the ID of the linked account in another system, or null when none is set. At most 255 characters and unique across your app's installations, so you can find an installation with GET /app_installations?external_id=; setting one another installation already has returns a 409. Only the app and its developer see it; for the account the app is installed on it is always null.

Voorbeeld:

"acme-books"

id
string
vereist

App installation ID, prefixed aag_.

Voorbeeld:

"aag_xxxxxxxxxxxxxx"

metadata
object | null
vereist

String keys and values your app stores about this installation, such as a sync cursor or the ID of the linked account in another system. Empty until your app sets a key, and kept if the account removes the app and installs it again. At most 50 keys; keys are at most 100 characters and values at most 500. Only the app can change it. Only the app and its developer see it; for the account the app is installed on it is always null.

Voorbeeld:
requesting_reauthorization
boolean
vereist

Whether the app now asks for permissions the account hasn't approved yet.

Voorbeeld:

false

updated_at
string
vereist

When the installation last changed, such as a metadata update or the account changing the app's permissions, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"