---
title: "Get app"
method: POST
path: "/v2/apps.getApp"
tags: ["apps"]
---

# Get app

`POST /v2/apps.getApp`

Retrieve a single app by its id or slug within a project.

Use this to fetch app details after creation or to verify an app exists before performing operations.

**Required Permissions**

Your root key must have one of the following permissions:
- `app.*.read_app` (to read any app)
- `app.<app_id>.read_app` (to read a specific app)

## Request body

- V2AppsGetAppRequestBody
  - `project` string, required — Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
  - `app` string, required — Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

## Response `200`

Successfully retrieved the app.

- V2AppsGetAppResponseBody
  - `meta` Meta, required — Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The `requestId` is particularly important when troubleshooting issues with the Unkey support team.
    - `requestId` string, required — A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.
  - `data` App, required
    - `id` string, required — The unique identifier of the app, generated by Unkey.
    - `name` string, required — Human-readable name for this app.
    - `slug` string, required — URL-safe handle for this app, unique within its project. Chosen at creation time.
    - `git` AppGit
      - `repository` string, required — The connected GitHub repository, as "owner/repo".
      - `defaultBranch` string — The branch this app's deployments track.
    - `currentDeploymentId` string — The identifier of the deployment currently serving this app. Omitted if the app has no active deployment yet.
    - `isRolledBack` boolean, required — Whether the app is currently serving a rolled-back deployment rather than its latest one.
    - `deleteProtection` boolean, required — Whether delete protection is enabled for this app. When true, the app cannot be deleted until protection is disabled.
    - `createdAt` integer, required — Unix timestamp in milliseconds when the app was created.
    - `updatedAt` integer — Unix timestamp in milliseconds when the app was last updated. Omitted if the app has never been updated.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden - Insufficient permissions (requires `app.*.read_app`)
- `404` — Not Found - The requested app does not exist in your workspace
- `429` — Too Many Requests
- `500` — Internal server error

## Changes

- **2026-08-03** `2dcddab7f374` — 1 breaking, 1 info
  - removed the required property `data/defaultBranch` from the response with the `200` status
  - added the optional property `data/git` to the response with the `200` status
- **2026-07-14** `43ad1ce9a152` — 2 info
  - the endpoint scheme security `bearer` was added to the API
  - the endpoint scheme security `rootKey` was removed from the API
- **2026-07-06** `0f7e331eeffa` — 1 breaking
  - removed the required property `data/projectId` from the response with the `200` status
- **2026-06-25** `27074b3b2381` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/unkeyed/apis/unkey-api/changes/v2/apps.getApp/post.md)

---

[API](https://skmtc.dev/unkeyed/apis/unkey-api.md) · [All operations](https://skmtc.dev/unkeyed/apis/unkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/unkeyed/unkey-api/revisions/982b36cad359/schema)