List Forms | Pinnacle | Documentation

import { PinnacleClient } from "rcs-js";
async function main() {
    const client = new PinnacleClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.forms.list({
        pageIndex: 0,
        pageSize: 20,
    });
}
main();

{
  "data": [
    {
      "id": "form_Oy2n7iUoi9CJwUU6",
      "url": "https://forms.pinnacle.sh/form_Oy2n7iUoi9CJwUU6",
      "name": "Contact request",
      "fields": [
        {
          "type": "text",
          "key": "full_name",
          "label": "Full name",
          "required": true
        },
        {
          "type": "email",
          "key": "email",
          "label": "Email",
          "required": true
        }
      ],
      "can_update": false,
      "submission_count": 12,
      "last_submitted_at": "2026-04-23T22:15:04.406Z",
      "created_at": "2026-04-01T12:00:00Z",
      "updated_at": "2026-04-23T22:15:04.430Z"
    }
  ],
  "hasMore": false,
  "count": 1
}

Paginated list of forms on your team, sorted by creation date (newest first). Includes archived forms.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

pageIndexintegerOptional>=0Defaults to 0

Zero-based page index.

pageSizeintegerOptional1-100Defaults to 20

Number of forms to return in a single page. Max 100.

Response

Paginated list of forms.

datalist of objects

Forms on this page, newest first.

hasMoreboolean

True if there are more pages after this one. Fetch the next page by incrementing pageIndex.

countinteger

Number of forms returned in data. Always equals data.length.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error