List installed apps

GET

/teams/{teamId}/domains/{domainId}/apps

const url = 'https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15/apps';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Lists the apps installed on the site: what each one does, its selected and running versions, its switch, and its installs. Call it to discover the appSlug the other site-app operations address.

Required permissions

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

Authorizations

QintoAccessToken

Parameters

Path Parameters

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.

Responses

200

The site’s installed apps.

application/json

object

apps

required

The site’s installed apps, oldest install first.

Array<object>

An app installed on a site, with its versions, switch, and install summary.

object

domainAppId

required

Server-assigned id of this installation.

string

slug

required

Immutable slug the app runs under. Address it in the other site-app operations.

string

name

required

Display name of the app.

string

description

required

The app’s summary; null when not set.

string | null

flows

required

What the app does with events: reshape them at ingest (transform), receive them after commit (destination), or both.

Array<string>

Allowed values: transform destination

consentCategory

required

The consent category gating the app’s delivery on customer pages.

string

enabled

required

The app-level kill switch; a disabled app receives nothing.

boolean

desiredVersion

required

The version selected for this site.

string

deployedVersion

required

The version the site actually runs; null while the first deployment is pending.

string | null

required

Whether the deployed version ships an embedded UI panel; false while no version is deployed.

boolean

installCount

required

How many installs of the app the site has.

integer

installLabels

required

The installs’ labels, in install order.

Array<string>

pendingGrantCount

required

How many app-permission requests involving this app await a decision.

integer

Example

{
  "apps": [
    {
      "domainAppId": "6c5b4a39-2817-4d6e-9f0a-1b2c3d4e5f6a",
      "slug": "facebook-capi",
      "name": "Facebook CAPI",
      "description": "Send events to the Facebook Conversions API.",
      "flows": [
        "destination"
      ],
      "consentCategory": "marketing",
      "enabled": true,
      "desiredVersion": "1.4.1",
      "deployedVersion": "1.4.0",
      "ui": false,
      "installCount": 2,
      "installLabels": [
        "Facebook (EU)",
        "Facebook (US)"
      ],
      "pendingGrantCount": 1
    }
  ]
}

400

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

application/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"
        ]
      }
    }
  }
}

401

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

application/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"
}

403

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.

application/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."
}

404

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

application/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"
}

500

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

application/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"
}