---
title: "GET /apps/"
method: GET
path: "/apps/"
tags: ["Apps"]
---

# GET /apps/

`GET /apps/`

## Query parameters

- `optionId` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- AppResponse[]
  - `admin_id` integer, required — ID of the admin that created the application
  - `admin_name` string, required — Name admin that created the application
  - `app_form` AppForm
    - `form_builder` FormBuilderLayout, required
      - `definitions` object, required
      - `main` object, required
    - `json_schema` JSONSchemaLayout
      - `definitions` object, required — Definitions used to validate an App's form data
      - `schema` object, required — Schema used to validate an App's form data
    - `test_data` object — Test data used to validate the form
  - `categories` string[], required — Names of the categories this app belongs to (resolved from category_ids)
  - `category_ids` integer[] — IDs of the app categories (see /apps/categories) this app belongs to
  - `changed` string, date-time, required — Date and time the application was last changed
  - `changed_ts` integer, required
  - `cloud_init_template` string — Cloud init template for the application, this is used to provide the cloud init configuration for the application. The templating syntax is Jinja2
  - `created` string, date-time, required — Date and time the application was created
  - `created_ts` integer, required
  - `description` string — Description of the application, this is used to provide context to the user
  - `help_text_template` string — Markdown help doc for the application, this is used to provide documentation to the application and its form requirements
  - `id` integer, required — ID of the application
  - `image_url` string — URL of the image for the app option to display in store
  - `included_features` string[] — Marketed bullet points / features for this app
  - `name` string, required — Name of the application, this is used as a verbatim key in configuration data
  - `set_no_app_form` boolean — Set this to true to disable the form for this application, this is used to disable the form for applications that do not require user input. App form most NOT be supplied when this is true for updating apps. This was is a workaround for swagger typescript generation not supporting nullable fields.
  - `sps_app_option_id` integer — ID of the SPS app-option to link to this app
  - `sps_app_option_name` string — Name of the SPS App option linked to
  - `sps_base_os_option_id` integer, required — ID of the base SPS OS option to link to this app
  - `sps_base_os_option_name` string, required — Name of the base SPS OS option linked to this app
  - `tag_ids` integer[] — IDs of the app tags (see /apps/tags) applied to this app
  - `tags` string[], required — Names of the tags applied to this app (resolved from tag_ids)
  - `title` string, required — Title of the application, this is used to provide context to the user
  - `vps_app_option_id` integer — ID of the VPS app-option to link to this app
  - `vps_app_option_name` string — Name of the VPS App option linked to
  - `vps_base_os_option_id` integer, required — ID of the base VPS OS option to link to this app
  - `vps_base_os_option_name` string, required — Name of the base VPS OS option linked to this app

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/revisions/ee6b717b5015/schema)