Get a project | Octri API

1 parameter

projectIdstringrequired

The project's ID, from listProjects.

3 status codes

200The project.

projectobjectrequired

The stored project. It also carries settings not listed here.

specobjectoptional

401The API key is missing or invalid.

errorobjectrequired

404The project or resource does not exist in this organisation.

errorobjectrequired

Error handling

A 401 is returned: The API key is missing or invalid. A 404 is returned: The project or resource does not exist in this organisation.

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.get({ projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "project": {
    "_id": "550e8400-e29b-41d4-a716-446655440000",
    "customDomain": "example_value",
    "docsSubdomain": "example_value",
    "name": "Example Name",
    "slug": "my-example-resource",
    "status": "active"
  },
  "spec": {
    "createdAt": "2026-01-15T09:00:00Z",
    "endpointCount": 42,
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "active",
    "updatedAt": "2026-01-15T09:00:00Z",
    "version": "example_value"
  }
}

Request

Response

Errors