Get connection

Get connection

This API endpoint retrieves detailed connection data and the target user profile, identified by their respective user IDs.

URL: {{API_BASE_URL}}/byndr/v1/users/{{INITIATOR_USER_ID}}/connections/{{TARGET_USER_ID}}?event={{EVENT_STUDYDAYS}}

Request Parameters

• initiatorUserId (Path Parameter): The user ID of the initiator of the connection.

• targetUserId (Path Parameter): The user ID of the target user whose connection details are being fetched.

• event (Query Parameter): The specific event for which the connection details are being requested. In this case, it is set to studidaysv5.

Response

The response will include the following data structure:

• data: An object containing:

  • initiatorUserId: The ID of the user who initiated the connection.

  • profile: An object with the target user's profile information, including:

    • id: The user's unique identifier.

    • salutation: The user's salutation.

    • firstName: The user's first name.

    • lastName: The user's last name.

    • email: The user's email address.

    • company: The user's company name.

    • title: The user's job title.

    • website: The user's website (if available).

    • phone: The user's phone number (if available).

    • mobile: The user's mobile number (if available).

    • fax: The user's fax number (if available).

    • vatId: The user's VAT ID (if available).

    • address: An object containing the user's address details:

      • street: The street name.

      • houseNumber: The house number.

      • postalCode: The postal code.

      • city: The city.

      • county: The county.

      • country: The country.

    • notificationPreferences: An object indicating the user's preferences for notifications via email, phone, and post mail.

  • encounters: An array of objects representing encounters related to the connection, each containing:

    • eventIdentifier: An identifier for the event (if applicable).

    • timeStamp: The timestamp of the encounter.

    • note: Any notes associated with the encounter (if applicable).

  • status: The current status of the connection.

Relevant Notes

• Ensure that the user IDs provided in the request are valid and correspond to existing users in the system.

• The response may contain null values for fields that are not applicable or not available for the target user.