TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node operation retrieves detailed information about a single participant of a calendar event by its unique identifier. It is useful when you need to fetch specific participant data from an event, such as their status, role, or contact details, without retrieving the entire event or all participants.

Practical examples include:

  • Fetching the RSVP status of a particular participant.
  • Retrieving contact information for follow-up communications.
  • Checking participant roles (e.g., organizer, attendee) in an event.

Properties

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

Output

The output JSON contains the detailed data of the requested calendar event participant. Depending on the Depth property, this includes:

  • At depth 0: Basic participant information only.
  • At depth 1: Participant information plus directly related objects (e.g., linked user profile).
  • At depth 2: Participant, directly related objects, and their related nested objects.

If the API supports binary data for any participant-related content (e.g., attachments), it would be included accordingly, but this node primarily outputs structured JSON data representing the participant.

Dependencies

  • Requires an API key credential for authenticating with the Twenty API service.
  • The node uses the base URL configured via credentials.
  • No additional external dependencies are required beyond the provided API access.

Troubleshooting

  • Missing or invalid Id: The node requires a valid participant ID. Ensure the ID is correct and exists in the calendar system.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Depth parameter misuse: Using a higher depth may increase response size and latency; use the minimal necessary depth.
  • Network issues: Check connectivity to the API endpoint if requests time out or fail.

Common error messages might include:

  • "Participant not found": Indicates the given ID does not correspond to any participant.
  • "Unauthorized": Authentication failed due to missing or invalid API key.
  • "Bad Request": Possibly caused by invalid parameters like malformed ID or unsupported depth value.

Resolving these typically involves verifying input values and credential configurations.

Links and References

Discussion