Skip to main content
GET
/
v1
/
api
/
apps
List apps
curl --request GET \
  --url https://api.hq.zone/v1/api/apps \
  --header 'Authorization: Bearer <token>'
{
  "apps": [
    {
      "created_at": 123,
      "declared_port": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_activity_at": 123,
      "run_mode": "<string>",
      "slug": "<string>",
      "state": "<string>",
      "url": "<string>",
      "visibility": "<string>",
      "backing_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "max_persistent": 123,
  "used": 1
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Response

200 - application/json

Workspace app catalog

apps
object[]
required
max_persistent
integer<int32>
required

The apps quota - plan-driven (plan.max_apps) with a fallback to the legacy tenants.max_persistent_surfaces - and how many non-destroyed apps count against it. Drives the "N of M slots used" line.

used
integer
required
Required range: x >= 0