API ReferenceContacts

List Contacts

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

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.

Response

Returns paginated list of contacts.
datalist of objects
hasMoreboolean
countinteger

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error