TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation retrieves a single message participant object by its unique identifier. It is useful when you need to fetch detailed information about a specific participant in a messaging context, such as for auditing, displaying participant details, or processing participant-related data in workflows.

Practical examples include:

  • Fetching the details of a user involved in a conversation.
  • Retrieving participant metadata for display in a dashboard.
  • Accessing nested related objects of a participant to understand their associations.

Properties

Name Meaning
Id The unique identifier of the message participant object to retrieve.
Depth Determines how much related nested data to include:
- 0: Only the primary participant object.
- 1: Participant plus directly related objects.
- 2: Participant, directly related objects, and their related objects.

Output

The output JSON contains the data of the requested message participant object. Depending on the Depth property, this data may include nested related objects up to two levels deep. This allows flexible retrieval of associated data without additional requests.

If the node supports binary data (not indicated here), it would typically represent attachments or media related to the participant, but no binary output is specified in this operation.

Dependencies

  • Requires an API key credential to authenticate with the external Twenty API service.
  • The node uses the base URL configured via credentials to send requests.
  • No other external dependencies are indicated.

Troubleshooting

  • Missing or invalid Id: Ensure the Id property is provided and correctly references an existing message participant.
  • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
  • Depth parameter issues: Use only allowed values (0, 1, or 2) for the Depth property to avoid unexpected responses.
  • Network or API errors: Check connectivity and API status if requests fail.

Common error messages might include "Not Found" if the Id does not exist, or "Unauthorized" if credentials are invalid.

Links and References

Discussion