Supportpal icon

Supportpal

Consume Supportpal REST API (v.1.2.4)

Actions22

User → Get All

AI-generated

Overview

This node interacts with the Supportpal REST API to retrieve all user entries based on specified query parameters. It supports filtering users by various attributes such as brand ID, first name, last name, email, confirmation status, activity status, organization details, phone, country, language code, and pagination options like start, limit, and sorting order. The node can also include custom fields in the query. This operation is useful for scenarios where you need to fetch a list of users matching certain criteria, for example, retrieving all active users from a specific organization or all users who have confirmed their email.

Use Case Examples

  1. Fetch all active users from a specific organization by setting the 'Active?' parameter to true and providing the 'Organisation ID'.
  2. Retrieve users filtered by country and language code to target a specific demographic.
  3. Get a paginated list of users sorted by their ID in ascending or descending order.

Properties

Name Meaning
Simplify Response If enabled, the response will be simplified to only return the user data without additional metadata.
Query Parameters Filters and options to refine the list of users retrieved, including brand ID, first name, last name, email, confirmation status, activity status, organization ID and name, phone, country, language code, pagination start, limit, and sorting order.
Custom Fields Additional custom fields to include in the query for filtering users, specified by field ID and value.

Output

JSON

  • id - Unique identifier of the user.
  • firstname - First name of the user.
  • lastname - Last name of the user.
  • email - Email address of the user.
  • confirmed - Boolean indicating if the user has confirmed their email.
  • active - Boolean indicating if the user account is active.
  • organisation_id - ID of the organization the user belongs to.
  • organisation_name - Name of the organization the user belongs to.
  • phone - Phone number of the user.
  • country - Country code of the user.
  • language_code - Language code of the user.
  • customfield - Custom fields associated with the user, if any.

Dependencies

  • Supportpal REST API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access user data.
  • Check that the query parameters are valid and correctly formatted to avoid API errors.
  • If the node returns an error, verify the network connectivity to the Supportpal API endpoint.
  • When using custom fields, ensure the field IDs exist and are accessible in the Supportpal instance.

Links

Discussion