Skip to content

List an app’s installs

GET
/teams/{teamId}/domains/{domainId}/apps/{appSlug}/installs
curl --request GET \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/apps/facebook-capi/installs \
--header 'Authorization: Bearer <token>'

Lists the installations of one app on a site, with the id each of the install-scoped operations addresses. An app installed once has exactly one.

How it works

Removed installs are left out, and ordinals are permanent — a gap means an install was removed, not that one is missing.

Required permissions

  • domain:read on all domains, or on the addressed domain when its id is in the route
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

domainId
required

Unique id (UUID) of the site, as returned by the site operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the site, as returned by the site operations.

appSlug
required

Immutable slug of the app, as shown by the list operation.

string
/^[a-z][a-z0-9-]{2,29}$/

Example

facebook-capi

Immutable slug of the app, as shown by the list operation.

The app’s installs.

Media typeapplication/json
object
installs
required

The app’s live installs, in install order.

Array<object>

One install of an app on a site, addressable by its id.

object
appInstallId
required

Id of this install.

string
ordinal
required

The install’s permanent ordinal; never reused after removal.

integer
label
required

The label every surface shows for this install.

string
enabled
required

The install’s own switch, beneath the app-level one.

boolean
geoFilter
required
Any of:

Where the install runs for visitors’ browser sessions. Each entry is an ISO 3166-1 alpha-2 country code (SI), EU for the European Union, or an ISO 3166-2 code for one of the 50 US states or the District of Columbia (US-CA). The install runs only when the visitor’s location is known, the include list is empty or one of its entries matches, and no exclude entry matches. A country code matches that country, EU matches a country in the European Union, and a state code matches a US visitor in that state. The location is unknown, and the install does not run, when the visitor’s country is not reported, when a list names a US state and a US visitor’s state is not reported, or when a list holds EU and the visitor’s location carries no EU flag. Server SDK events, schedules, webhooks, app endpoints, MCP tools and calls from other apps are not filtered.

object
include
required

Locations the install runs in; empty means every location the exclude list allows.

Array<string>
exclude
required

Locations the install never runs in.

Array<string>

Example

{
"installs": [
{
"appInstallId": "8d7c6b5a-4938-4271-a605-9e8f7a6b5c4d",
"ordinal": 1,
"label": "Facebook (EU)",
"enabled": true,
"geoFilter": {
"include": [
"EU"
],
"exclude": []
}
}
]
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}