List Contacts API Reference

Serverhttps://api.pinnacle.sh/

List all contacts with optional filtering and 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

phoneNumberstringOptional

Filter contacts by phone number (E.164 format).

Example

"+14155550142"

namestringOptional

Filter contacts by name (partial match).

Example

"Acme Support"

tagsarray<string>Optional

Filter contacts by tags.

Each item

Example

"vip"

isArchivedbooleanOptional

Filter contacts by archived status.

Example

true

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.contacts.list();

Responses

{  "data": [    {      "id": "co_abc123",      "phoneNumber": "+12125551234",      "name": "John Doe",      "email": "john@example.com",      "tags": [        "vip",        "beta"      ]    },    {      "id": "co_def456",      "phoneNumber": "+14155556789",      "name": "Jane Smith"    }  ],  "hasMore": true,  "count": 48}

List Contacts

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Contacts

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`