List projects | Octri API

2 status codes

200The projects and the organisation's usage against its limit.

projectsarray<object>required

usageobjectrequired

401The API key is missing or invalid.

errorobjectrequired

Error handling

A 401 is returned: The API key is missing or invalid.

import { Octri } from "octri-api-sdk";

const client = new Octri({
  baseUrl: "https://api.octri.dev",
  auth: { apiKeyAuth: process.env.OCTRI_API_KEY! },
});

const result = await client.projects.list();

{
  "projects": [
    {
      "createdAt": "2026-01-15T09:00:00Z",
      "customDomain": "example_value",
      "docsSubdomain": "example_value",
      "docsUrl": "https://example.com",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Example Name",
      "slug": "my-example-resource",
      "status": "active",
      "updatedAt": "2026-01-15T09:00:00Z"
    }
  ],
  "usage": {
    "limit": 20,
    "projects": 1
  }
}

Response

Errors