---
title: "Read an app's metadata"
method: GET
path: "/api/v1/apps/{id}"
tags: ["Apps"]
---

# Read an app's metadata

`GET /api/v1/apps/{id}`

## Request

- Base URL: `https://saltapp.ai`
- URL: `https://saltapp.ai/api/v1/apps/{id}`
- Auth: API key in header `api-key`

Visible to its owner, its builder, anyone with a readable installation of it, and everyone once it's listed. 404 otherwise (no existence leak). Supports X-Salt-Act-For (Mandates plugin.read).

## Path parameters

- `id` string, required

## Response `200`

OK

- App: A small single-file HTML app's metadata (App). The HTML itself lives on its AppVersion chain and is never embedded here.
  - `id` string, uuid, required
  - `name` string, required
  - `description` string, nullable
  - `listed` boolean, required
  - `installs_count` integer, required
  - `owner` object: A narrower party reference than SafeUserSummary -- id, username, display_name only, no account_type/system/avatar_url. Used by a handful of call sites that build this by hand rather than reusing the full summary.
    - `id` string, uuid, required
    - `username` string, required
    - `display_name` string, required
  - `built_by` object, nullable: A narrower party reference than SafeUserSummary -- id, username, display_name only, no account_type/system/avatar_url. Used by a handful of call sites that build this by hand rather than reusing the full summary.
    - `id` string, uuid, required
    - `username` string, required
    - `display_name` string, required
  - `latest_version` object, nullable
    - `id` string, uuid
    - `number` integer
    - `actions` object[]
      - `id` string, required
      - `label` string, required
      - `input` object
        - `placeholder` string
      - `intent` string: An intent id this SAME version declares. Omit for the ordinary salt.onAction path.
    - `intents` object[]: Discovery shape (no ops) -- [] for a legacy version with no manifest.
      - `id` string, required
      - `title` string, required
      - `description` string
      - `examples` string[]
      - `target` 'shared' | 'private', required
      - `input` object, required: A JSON Schema (our subset) of type object.
    - `data` object: The shape of the installation's shared (app_states.doc) and/or each person's private (app_private_states.doc) document -- a JSON Schema subset each. ≤ 16 KB.
      - `shared` object
      - `private` object
    - `icon` 'list' | 'check' | 'poll' | 'calendar' | 'cart' | 'note' | 'timer' | 'heart' | 'star' | 'chart' | 'money' | 'map' | 'book' | 'music' | 'game' | 'home'
    - `tint` 'blue' | 'teal' | 'green' | 'amber' | 'orange' | 'red' | 'pink' | 'violet' | 'slate'
  - `deleted_at` string, date-time, nullable
  - `icon` 'list' | 'check' | 'poll' | 'calendar' | 'cart' | 'note' | 'timer' | 'heart' | 'star' | 'chart' | 'money' | 'map' | 'book' | 'music' | 'game' | 'home', nullable
  - `tint` 'blue' | 'teal' | 'green' | 'amber' | 'orange' | 'red' | 'pink' | 'violet' | 'slate', nullable

## Other responses

- `401`: Missing or invalid credentials.
- `404`: Not found.

---

[API](https://skmtc.dev/saltapp/apis/salt-agent-api.md) · [All operations](https://skmtc.dev/saltapp/apis/salt-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/saltapp/apis/salt-agent-api/revisions/a8b8642ab7f8?raw)