List projects

List projects visible to your account, including their service counts and environment summaries.

GET/api/projectsHTTPS

Request & response examples

Request exampleServer-side

curl --fail-with-body --request GET \
  'https://app.helicarrier.xyz/api/projects' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/projects",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`
    }
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "GET",
    "https://app.helicarrier.xyz/api/projects",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example200

[
  {
    "id": "prj_example",
    "name": "My project",
    "slug": "my-project",
    "description": "",
    "serviceCount": 2,
    "services": [
      {
        "sourceType": "image"
      },
      {
        "sourceType": "database",
        "engine": "postgres"
      }
    ]
  }
]

Illustrative values · selected fields

Response details OpenAPI

Authorization

An account key with access to the resource. Project and service keys do not authorize this operation.

Authorization: Bearer <key>Key setup

Parameters

This request does not require path, query, or body parameters.

Response 200

The serviceCount is the actual count. The services field is a capped preview of service types for project cards, not a list of full service records. Use Get project for services in a specific environment.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

idstring

Unique identifier of this resource.

namestring

Human-readable resource name.

slugstring

URL-safe resource identifier.

descriptionstring

Description of the resource or capability.

serviceCountinteger

Total number of services, not the length of the preview array.

servicesarray

Services in the selected environment, or type previews in a project listing.

Child fields

sourceTypestring
Source used to build or run the service.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`list_projects`

Required MCP arguments: none. Send path, query, and body fields together as tool arguments.

Connect your agent

import os import requests response = requests.request( "GET", "https://app.helicarrier.xyz/api/projects", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.

[ { "id": "prj_example", "name": "My project", "slug": "my-project", "description": "", "serviceCount": 2, "services": [ { "sourceType": "image" }, { "sourceType": "database", "engine": "postgres" } ] } ]