Get board details | StatusGator Octri Preview

1 parameter

idstringrequired

The public ID of the board to retrieve.

3 status codes

200Returns the board details, including its ID, name, public token, and creation and update timestamps.

dataobjectoptional

successbooleanoptional

401Returned when the request is unauthenticated.

404Returned when no board exists with the given ID.

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the id path parameter does not identify an existing board.

import { StatusGatorAPIUnofficialOctriFullPreview } from "statusgator-octri-preview-sdk";

const client = new StatusGatorAPIUnofficialOctriFullPreview({
  baseUrl: "https://statusgator.com/api/v3",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.boards.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": {
    "created_at": "2025-09-12T12:35:54Z",
    "id": "m2z5x3nOJa",
    "name": "Cloud Services",
    "public_token": "abc123def456",
    "updated_at": "2025-09-12T12:40:54Z"
  },
  "success": true
}

Request

Response

Errors