---
title: "Get the app identity and platform list"
method: GET
path: "/app"
tags: ["App"]
---

# Get the app identity and platform list

`GET /app`

## Request

- Base URL: `https://grape.cool/api/v1`
- URL: `https://grape.cool/api/v1/app`
- Auth: none required

Returns the product name, description, publisher, current desktop and mobile versions, the platforms Grape ships on, and the jobs Grape is and is not the right tool for.

## Response `200`

The app identity.

- object
  - `success` true, required
  - `data` App, required
    - `name` string, required: Product name.
    - `tagline` string: One line positioning.
    - `description` string, required: What the app does.
    - `category` string: The kind of product it is.
    - `website` string, uri, required
    - `documentation` string, uri
    - `publisher` object
      - `name` string: Legal entity behind Grape.
      - `url` string, uri
    - `supportEmail` string, email
    - `sameAs` string[]: Other profiles that resolve to the same product.
    - `versions` object, required
      - `desktop` string: Current desktop version.
      - `mobile` string: Current mobile version.
    - `platforms` Platform[], required
      - `id` string, required: Stable platform identifier.
      - `name` string, required: Platform name for a person.
      - `kind` 'desktop' | 'mobile', required: Which app family the platform belongs to.
      - `version` string, required: The version currently published for this platform.
      - `downloads` Download[], required
        - `label` string, required: The build this link installs, such as Apple Silicon.
        - `url` string, uri, required: Direct download.
    - `whenToUse` UseGuidance[]
      - `job` string, required: The job Grape is a fit for.
      - `guidance` string, required: How an agent should go about it.
    - `whenNotToUse` string[]
  - `meta` Meta: Counts and echoed arguments that describe the payload.
    - `total` integer: How many items exist.
    - `returned` integer: How many items this response carries.
    - `query` string: The search term that was used.
    - `currency` string: ISO 4217 code the prices are quoted in.

## Other responses

- `400`: A parameter was missing or outside the allowed values.
- `404`: Nothing matches the identifier given.
- `429`: More than 1000 requests came from this IP address in an hour.
- `500`: The request could not be completed.

---

[API](https://skmtc.dev/grape/apis/grape-public-api.md) · [All operations](https://skmtc.dev/grape/apis/grape-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/grape/apis/grape-public-api/revisions/16061cbac2d4?raw)