Monocle icon

Monocle

Interact with Monocle API

Actions7

Overview

This node interacts with the Monocle API to retrieve information about groups and their members within a specified workspace or index. Specifically, the "Get Members" operation under the "Group" resource fetches the list of members belonging to a particular group.

Typical use cases include:

  • Automating the retrieval of group membership data for reporting or auditing purposes.
  • Integrating group member information into workflows that manage access control or notifications.
  • Synchronizing group member lists with other systems or databases.

For example, you might use this node to get all members of a development team group in your organization to send them targeted updates or to analyze team composition.

Properties

Name Meaning
Index Selects the workspace or context from which to retrieve the group members. Options are loaded dynamically from available workspaces. You can choose from the list or specify a string expression.
Group The identifier (name or ID) of the specific group whose members you want to retrieve. This is a string input.

Output

The node outputs JSON data containing the members of the specified group. The structure of the output JSON includes a members field, which is an array listing the details of each group member as returned by the Monocle API.

Example output structure:

{
  "members": [
    {
      "id": "member1",
      "name": "Member One",
      "email": "member.one@example.com",
      ...
    },
    {
      "id": "member2",
      "name": "Member Two",
      "email": "member.two@example.com",
      ...
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Monocle API via an API key credential configured in n8n.
  • The node uses the base URL https://demo.changemetrics.io for API requests.
  • The "Index" property depends on dynamically loaded workspace options, so proper configuration and permissions to access these workspaces are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an incorrect or non-existent group identifier will result in empty or error responses.
    • Using an invalid index/workspace may lead to no data being returned or errors.

  • Error messages:

    • Authentication errors typically indicate problems with the API key; verify the credential setup.
    • "Group not found" or similar errors suggest the provided group name/ID does not exist in the selected workspace.
    • Network or timeout errors may occur if the Monocle API service is unreachable; check network connectivity.

To resolve these issues, ensure that:

  • The API key credential is correctly configured and has sufficient permissions.
  • The "Index" and "Group" inputs are valid and correspond to existing entities in Monocle.
  • Your network allows outbound HTTPS requests to the Monocle API endpoint.

Links and References

Discussion