Actions8
Overview
This node operation retrieves a list of contact groups from the Nimba SMS service. It allows users to fetch either all groups or a limited subset based on specified filters such as search terms, ordering, and offset. This is useful for managing and organizing contacts into groups for targeted SMS campaigns or communication workflows.
Practical examples:
- Fetching all contact groups to display in a dashboard.
- Retrieving a paginated list of groups filtered by name or creation date.
- Ordering groups alphabetically or by date added to prioritize certain segments.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit (true/false). |
| Limit | Maximum number of group results to return when "Return All" is false. |
| Filters | Collection of optional filters to refine the results: |
| - Search | Text string to filter groups by matching names or other searchable fields. |
| - Ordering | Field to order the results by; supports ascending or descending with prefix - (e.g., name, -name, added_at, -added_at). |
| - Offset | Starting index from which to return results, useful for pagination. |
Output
The output is a JSON array where each item represents a contact group object retrieved from the Nimba SMS API. Each group object typically contains details such as group name, ID, creation date, and possibly other metadata provided by the API.
No binary data is output by this operation.
Dependencies
- Requires an active connection to the Nimba SMS API via an API key credential configured in n8n.
- The node uses internal helper functions to make authenticated HTTP requests to the Nimba SMS API endpoints.
- No additional external dependencies beyond the configured API access.
Troubleshooting
Common issues:
- Providing invalid filter values (e.g., unsupported ordering fields) may result in empty or error responses.
- Network or authentication errors if the API key is missing, expired, or incorrect.
- Requesting too many items without enabling "Return All" may truncate results unexpectedly.
Error messages:
- Errors related to API request failures will be thrown if the API returns an error status.
- If no groups are found matching the filters, the output will simply be an empty array.
- To resolve authentication errors, verify that the API key credential is correctly set up and has necessary permissions.
Links and References
- Nimba SMS API Documentation (for detailed API endpoint info)
- n8n Documentation (for general node usage and credential setup)