Skip to main content
GET
/
api
/
v1
/
apps
/
{appId}
Get App
curl --request GET \
  --url https://app.promptingco.com/api/v1/apps/{appId} \
  --header 'x-api-key: <api-key>'
{
  "ok": true,
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "resources": [
      {
        "id": "<string>",
        "appId": "<string>",
        "resourceType": "product",
        "resourceId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "product": {
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>"
        },
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "appConfig": {
      "config": {},
      "appId": "<string>",
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "organizationId": "<string>",
      "productId": "<string>"
    },
    "metadata": "<unknown>"
  }
}

Authorizations

​
x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

​
appId
string
required
Minimum string length: 1

Response

Successful response

​
ok
enum<boolean>
required
Available options:
true
​
data
object
required