List status page subscribers for a board | StatusGator Octri Preview

3 parameters

board_idstringrequired

Board ID

pageintegeroptional

Page number for pagination (default: 1)

per_pageintegeroptional

Number of items per page (default: 25, max: 100)

3 status codes

200subscribers found

dataarray<object>optional

paginationobjectoptional

successbooleanoptional

401unauthorized

errorsarray<string>optional

successbooleanoptional

404status page not found

errorsarray<string>optional

successbooleanoptional

Error handling

A 401 is returned: unauthorized. A 404 is returned: status page not found.

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.statusPageSubscribers.list({ boardId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": [
    {
      "confirmed": true,
      "confirmed_at": "2025-09-12T12:35:54Z",
      "created_at": "2025-09-12T12:35:54Z",
      "email": "user@example.com",
      "id": "m2z5x3nOJa",
      "monitor_ids": [
        "m2z5x3nOJa",
        "k9p8q7rStU"
      ],
      "updated_at": "2025-09-12T12:40:54Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 1,
    "per_page": 1,
    "prev_page": 1,
    "total_count": 42,
    "total_pages": 42
  },
  "success": true
}

Request

Response

Errors