List Network Requests | Pinnacle

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.network.requests.list({
        pageIndex: 0,
        pageSize: 20,
        type: "silent-auth",
        status: "completed",
        clientRef: "user_123",
    });
}
main();

{
  "data": [
    {
      "requestId": "nar_1234567890ABCDEF",
      "type": "silent-auth",
      "status": "completed",
      "clientRef": "user_123",
      "createdAt": "2026-06-12T18:25:00Z",
      "updatedAt": "2026-06-12T18:26:00Z",
      "completedAt": "2026-06-12T18:26:00Z",
      "expiresAt": "2026-06-12T18:30:00Z",
      "errorMessage": null,
      "result": {
        "requestId": "nar_1234567890ABCDEF",
        "status": "completed"
      }
    }
  ],
  "hasMore": false,
  "count": 1
}

List Network API request records for your team, sorted newest first. Use filters to audit recent checks by type, status, or your own clientRef.

Limited availability. Contact founders@pinnacle.sh to request access.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

pageIndexintegerOptional>=0Defaults to 0

Zero-based page index. Use 0 for the first page.

pageSizeintegerOptional1-100Defaults to 20

Number of records to return, from 1 to 100.

typeenumOptional

Type of Network API check.

Allowed values:

statusenumOptional

Lifecycle status of a Network API request. started and challenge-issued are in-progress states; completed, failed, and expired are terminal states.

Allowed values:

clientRefstringOptional1-40 characters

Filter by your correlation ID. Must be 1 to 40 characters when provided.

Response

Returns a paginated list of Network API request summaries.

datalist of objects

hasMoreboolean

Whether another page exists after this one.

countinteger

Total number of matching request records.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error