privateApp

Requires at least one of the permissions apps:app:read or settings:apps:manage.

One of this organization's private apps, with its versions.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PrivateApp($id: ID!) {
  privateApp(id: $id) {
    app {
      id
      name
      status
      createdAt
      appUrl
      clientId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PrivateApp($id: ID!) {\n  privateApp(id: $id) {\n    app {\n      id\n      name\n      status\n      createdAt\n      appUrl\n      clientId\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "privateApp": {
      "app": {
        "id": "id",
        "name": "string",
        "status": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "appUrl": "string",
        "clientId": "string"
      }
    }
  }
}

privateApp(
  id: ID!
): PrivateAppDetail!

Arguments

privateApp.id ● ID! non-null scalar

The private app's id.

Type

PrivateAppDetail object

A private app with its versions.