---
title: "Apps"
description: "Apps in the workspace. A server key can open every app."
canonical: https://docs.notifiable.sh/api/apps
source: https://docs.notifiable.sh/api/apps.md
---

# Apps

Apps in the workspace. A server key can open every app.

These routes are the public API. Send `Authorization: Bearer` with a workspace server API key. The key can act on every app in the workspace. A route that names an app uses that app id. `environment` is `development` or `production`.

## `GET /api/v1/public/apps`

The apps were listed.

Responses

- `200` `APPS_LISTED` — The apps were listed.
  - `page` (integer, required)
  - `per_page` (integer, required)
  - `total` (integer, required)
  - `apps` (array of object, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `422` `VALIDATION_FAILED` — The request contains invalid fields.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `POST /api/v1/public/apps`

The app was created.

Responses

- `201` `APP_CREATED` — The app was created.
  - `id` (string, required)
  - `name` (string, required)
  - `stack` (string, required)
  - `environment` (string, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `422` `VALIDATION_FAILED` — The request contains invalid fields.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `DELETE /api/v1/public/apps/{app}`

The app was deleted.

Path

- `app` — App id in this workspace.

Responses

- `200` `APP_DELETED` — The app was deleted.
  - `id` (string, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `404` `APP_NOT_FOUND` — The app could not be found.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `GET /api/v1/public/apps/{app}`

The app was found.

Path

- `app` — App id in this workspace.

Responses

- `200` `APP_FETCHED` — The app was found.
  - `id` (string, required)
  - `name` (string, required)
  - `stack` (string, required)
  - `environment` (string, required)
  - `delivery` (object, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `404` `APP_NOT_FOUND` — The app could not be found.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `PATCH /api/v1/public/apps/{app}`

The app was updated.

Path

- `app` — App id in this workspace.

Responses

- `200` `APP_UPDATED` — The app was updated.
  - `id` (string, required)
  - `name` (string, required)
  - `stack` (string, required)
  - `environment` (string, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `404` `APP_NOT_FOUND` — The app could not be found.
- `422` `VALIDATION_FAILED` — The request contains invalid fields.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `PATCH /api/v1/public/apps/{app}/environment`

The environment was updated.

Path

- `app` — App id in this workspace.

Body

- `environment` (string, required)

Responses

- `200` `ENVIRONMENT_UPDATED` — The environment was updated.
  - `id` (string, required)
  - `environment` (string, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `404` `APP_NOT_FOUND` — The app could not be found.
- `422` `VALIDATION_FAILED` — The request contains invalid fields.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.

## `POST /api/v1/public/apps/{app}/restore`

The app was restored.

Path

- `app` — App id in this workspace, including one that was deleted.

Responses

- `200` `APP_RESTORED` — The app was restored.
  - `id` (string, required)
- `401` `INVALID_API_KEY` — The API key is invalid.
- `404` `APP_NOT_FOUND` — The app could not be found.
- `422` `VALIDATION_FAILED` — The request contains invalid fields.
- `429` `RATE_LIMIT_EXCEEDED` — Too many requests. Please try again later.
- `500` `SERVER_ERROR` — Something went wrong. Please try again.