client.projects.list

List platform projects visible to the SDK API key.

Signature

class Client {
  projects: {
    list(query?: ListQuery): Promise<Project[]>
  }
}

interface ListQuery {
  status?: 'provisioning' | 'ready' | 'error' | 'deleted'
  limit?: number
  cursor?: string
}

Throws

Error	Condition
`AuthError`	Invalid or expired API key
`RateLimitError`	>100 req/min

Examples

Basic:

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

With filter + pagination:

const projects = await client.projects.list({ status: 'ready', limit: 50 })

Pitfalls

Key-scoped — same as REST: a project-scoped key sees only that project.
Pagination — use
```
cursor
```
from the response for the next page. Unbounded
```
list()
```
may exceed timeouts on tenants with 100+ projects.

See also

{auto-injected}

Tested against

{auto-injected}