Actions9
- Message Actions
- Contact Actions
- Group Actions
- Account Actions
- Purchase Actions
Contact → Get All
AI-generatedOverview
This node operation retrieves a list of contacts from the Nimba SMS API. It supports fetching either all contacts or a limited number based on user input. Users can apply filters such as a search term to narrow down the contacts and specify an offset for pagination. This operation is useful for scenarios where you need to manage or analyze contact lists, such as exporting contacts, syncing with other systems, or segmenting contacts for targeted messaging.
Use Case Examples
- Retrieve all contacts without limit to process or export the entire contact list.
- Fetch a limited number of contacts with a search filter to find specific contacts matching a term.
- Use offset to paginate through contacts in batches for processing or display.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return when not returning all. |
| Filters | Filters to apply when retrieving contacts, including search term and offset for pagination. |
Output
JSON
json- Each item contains a contact object retrieved from the Nimba SMS API.
Dependencies
- Nimba SMS API with an API key credential
Troubleshooting
- Invalid phone number errors occur if the contact data includes improperly formatted phone numbers; ensure phone numbers are valid and properly formatted.
- API request failures may happen due to network issues or invalid credentials; verify API key and network connectivity.
- If no contacts are returned, check the search filter and offset values to ensure they are correct and that contacts exist matching the criteria.
Links
- Nimba SMS API Contacts Documentation - Official API documentation for managing contacts with Nimba SMS.