---
title: "Get an app instance"
method: GET
path: "/v1/app-instances/{id}"
tags: ["app-instances"]
---

# Get an app instance

`GET /v1/app-instances/{id}`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/app-instances/{id}`
- Auth: HTTP bearer

Retrieve one configured app instance, including its full configuration.

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `data` AppInstance, required: An installed, configured app.
    - `id` string, required: App instance id.
    - `spaceId` string, required: Workspace id.
    - `appKey` string, required: The app type: a key from `GET /v1/apps/catalog` (`clock`, `weather`, `rss`, …).
    - `name` string, required
    - `config` unknown, required
    - `nodeId` string, nullable, required: Home location; null = workspace root.
    - `lastSnapshotKey` string, nullable, required: Internal key of the last rendered thumbnail.
    - `lastSnapshotAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `importSourceId` string, nullable, required: Id in the system it was imported from, if imported.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: No such app instance in this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)