BlueForge Docs

projects.list

List platform projects visible to the API key.

Returns all projects accessible with the current API key, including their status, plan, and usage.

Endpoint

MethodPathAuthIdempotent
GET
/api/platform/projects
Bearer {key}yes

Parameters

NameTypeRequiredDefaultNotes
status
stringno—Filter by status

Response

interface Project {
  id: string
  name: string
  slug: string
  status: 'provisioning' | 'ready' | 'error'
  plan: string
  usage: { storage_bytes: number }
  created_at: string
}

Examples

cURL:

curl https://api.blueforge.studio/api/platform/projects \
  -H "Authorization: Bearer $BF_API_KEY"

SDK:

import { Client } from "@blueforge/client"
const projects = await client.projects.list()

CLI:

forge project list

Pitfalls

  • Key-scoped visibility — API keys are project-scoped. A key created for project A cannot see project B.
  • Admin keys only — listing all projects requires an admin-scoped key. Read-only keys return only their own project.
  • Deleted projects — soft-deleted projects (
    status: 'deleted'
    ) are included by default. Filter with 
    ?status=ready
    .

See also

{auto-injected}

Tested against

{auto-injected}