List contacts
plunk_list_contactsBrowse or search contacts with pagination, filters, and sorting to find contacts when you lack the exact address or want to see who is in the project.
Instructions
Purpose: Browse or search contacts, with cursor pagination, email search, subscription filter and sorting.
Not for: Resolving a batch of known addresses to contacts — plunk_lookup_contacts does that in one call instead of searching repeatedly.
Returns: A page of contacts with a cursor for the next page.
Use when: Exploring who is in the project, or finding a contact whose exact address you do not have.
Note: Prefer narrowing with search or subscribed over paging through everything. The subscribed filter and sorting require Plunk v0.12+.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dir | No | Sort direction (used with `sort=email|createdAt`). | |
| page | No | Legacy page-based pagination. Prefer `cursor`. | |
| sort | No | Column to sort by. `email` and `createdAt` are v0.12+; `alphabetical` and `latest` are legacy aliases. | |
| limit | No | ||
| cursor | No | Cursor-based pagination token from a previous response. | |
| search | No | Case-insensitive substring match on email. | |
| subscribed | No | Filter by subscription state. Omit for both. |