Contacts

List Contacts

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

post/contacts/list

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/contacts/list
  • Auth: API key in header PINNACLE-API-KEY

Request body

pageIndexinteger
pageSizeinteger
phoneNumberstring

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

namestring

Filter contacts by name (partial match).

tagsstring[]

Filter contacts by tags.

isArchivedboolean

Filter contacts by archived status.

Response

Returns paginated list of contacts.

hasMoreboolean required
countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.