Blocklet Service icon

Blocklet Service

Consume Blocklet Service API

Actions12

User → Get Users

AI-generated

Overview

This node operation fetches a list of users from the Blocklet Service API with various filtering, sorting, and pagination options. It is useful for scenarios where you need to retrieve user data based on specific criteria such as roles, search keywords, DIDs, or tags, and optionally include related data like tags, connected accounts, or passports. For example, it can be used to get all users with a certain role or to search users by name or email.

Use Case Examples

  1. Retrieve all users with the role 'admin' and include their connected accounts.
  2. Search users by a keyword in their name or email and include their tags and passports.
  3. Fetch users filtered by specific DIDs and sorted by their creation date in descending order.

Properties

Name Meaning
Enabled Connected Account Whether to search the connected account of the user (boolean). Relevant for filtering users based on their connected accounts.
User Role Filter users by their role (string). Useful to get users belonging to a specific role.
Search Keyword (by Name, Email, Did) Filter users by a search keyword that matches their name, email, or DID (string).
User DIDs Filter users by one or more DIDs (string array).
Tag Names or IDs Filter users by tags, which can be selected from a list or specified by IDs (string array).
Include Tags Whether to include the tags of the user in the response (boolean).
Include Connected Accounts Whether to include the connected accounts of the user in the response (boolean).
Include Passports Whether to include the passports of the user in the response (boolean).
Sort Sorting options for the user list, including sorting by updated at, created at, or last login at timestamps (number values: 1 for ascending, -1 for descending).
Paging Paging options to specify the page number and page size for the user list.

Output

JSON

  • dids - The list of user DIDs returned by the API.
  • query - The query object containing filters applied such as role, search keyword, tags, and inclusion options.
  • paging - Paging information including page number and page size.
  • sort - Sorting criteria applied to the user list.

Dependencies

  • Blocklet Service API with an API key credential

Troubleshooting

  • Common issues include invalid or missing API credentials, which will cause authentication errors.
  • Incorrect filter values (e.g., invalid DIDs or tags) may result in empty results or errors from the API.
  • Pagination parameters must be valid numbers; otherwise, the API may reject the request.
  • If the node throws 'Not implemented user action' error, it means the operation is not supported by the node and should be corrected.

Links

Discussion