List Contacts
AI-generatedOverview
This node operation lists contacts from the Warmr Contacts service using the v1 API. It supports pagination, filtering, and searching to retrieve a customized list of contacts. This is useful for scenarios where you need to fetch and display contacts based on specific criteria such as page number, number of results per page, search terms, list UUID, archived status, or favorite status. For example, you can use it to display a paginated list of contacts matching a search query or filter contacts by their archived or favorite status.
Use Case Examples
- Fetch the first page of contacts with 50 results per page.
- Search contacts by first name, last name, or email.
- Filter contacts by a specific list UUID.
- Retrieve only archived or favorite contacts.
Properties
| Name | Meaning |
|---|---|
| Page | Page number for pagination (default is 1). Controls which page of results to retrieve. |
| Per Page | Number of results per page, with a maximum of 100. Controls how many contacts are returned per page. |
| Search | Search string to filter contacts by first name, last name, or email. |
| List UUID | Filter contacts by a specific list UUID. |
| Archived | Boolean flag to filter contacts by archived status. |
| Is Favorite | Boolean flag to filter contacts by favorite status. |
Output
JSON
json- Array of contact objects matching the filter and pagination criteria.
Dependencies
- Warmr API key credential required for authentication.
Troubleshooting
- Common issues include invalid API key or network errors causing failure to fetch contacts.
- If the API returns an error, the node outputs an error message in the JSON output under the 'error' property.
- Ensure that pagination parameters (page and perPage) are within valid ranges to avoid unexpected results.