Nimba SMS icon

Nimba SMS

Send SMS, manage campaigns, and track delivery reports using the Nimba SMS API with ease.

Actions9

Group → Get All

AI-generated

Overview

This node operation retrieves all contact groups from the Nimba SMS API. It supports fetching either all groups or a limited number based on user input. Users can apply filters such as search terms, ordering, and offset to customize the results. This operation is useful for managing and viewing contact groups within the Nimba SMS platform, for example, to display all groups or to find specific groups matching certain criteria.

Use Case Examples

  1. Retrieve all contact groups without limit to get a complete list.
  2. Fetch a limited number of groups with a search term to find specific groups.
  3. Order groups by name or creation date and paginate results using offset.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of groups to return when Return All is false.
Filters Filters to apply when retrieving groups, including search term, ordering, and offset.

Output

JSON

  • json - The JSON response containing group data from the Nimba SMS API.

Dependencies

  • Nimba SMS API with an API key credential

Troubleshooting

  • If no groups are returned, check the search filter and offset values to ensure they are correct.
  • If the node throws an error about API connectivity, verify the API key credential and network connection.
  • If the limit is set too high without Return All enabled, the node will only return up to the limit specified.

Discussion