List Shortened URLs API Reference

Serverhttps://api.pinnacle.sh/

List all shortened URLs with pagination. Results are sorted by creation date, newest first.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional

Range

0 <= value

Default

pageSizeintegerOptional

Range

1 <= value <= 100

Default

endpointstringOptional

Case-insensitive substring search on the destination URL.

Length

1 <= length <= 2000

Example

"https://example.com/webhooks/messages"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.tools.url.list();

Responses

{  "data": [    {      "from": "https://pncl.to/abc123",      "to": "https://example.com/landing-page",      "expiresAt": "2025-12-31T23:59:59Z",      "createdAt": "2025-01-15T10:30:00Z"    },    {      "from": "https://pncl.to/def456",      "to": "https://example.com/promo",      "expiresAt": null,      "createdAt": "2025-01-10T08:00:00Z"    }  ],  "hasMore": false,  "count": 2}

List Shortened URLs

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Shortened URLs

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`