List Contacts | Pinnacle

List all contacts with optional filtering and pagination. Results are sorted by creation date, newest first.

PINNACLE-API-KEYstring

API Key authentication via header

This endpoint expects an object.

pageIndexintegerOptional>=0Defaults to 0

pageSizeintegerOptional1-100Defaults to 20

phoneNumberstringOptional

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

namestringOptional

Filter contacts by name (partial match).

tagslist of stringsOptional

Filter contacts by tags.

isArchivedbooleanOptional

Filter contacts by archived status.

Returns paginated list of contacts.

datalist of objects

hasMoreboolean

countinteger

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.contacts.list({});
8	}
9	main();

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.contacts.list({});
8	}
9	main();