Preview profile by quicode

Preview User Profile Connection

This endpoint allows you to preview a user's profile connection based on the unique identifier quicode. It is particularly useful for retrieving information about a target user's profile before establishing a connection.

Request

• Method: POST

• Endpoint: {{API_BASE_URL}}/byndr/v1/users/:initiatorUserId/connections/preview-profile

Request Body

The request body must be in JSON format and include the following parameter:

• quicode (string): A unique code representing the target user whose profile is to be previewed. (e.g. a tickets badge QR code)

Example Request Body:

Response

Upon a successful request, the response will return a status code of 200 and will include the following structure in JSON format:

• data: An object containing:

  • initiatorUserId (string): The ID of the user initiating the request.

  • targetUserProfile: An object containing the target user's profile details:

    • id (string): The unique identifier of the target user.

    • salutation (string): The salutation of the target user.

    • firstName (string): The first name of the target user.

    • lastName (string): The last name of the target user.

    • email (string): The email address of the target user.

    • company (string): The company name of the target user.

    • title (string): The job title of the target user.

    • website (string, nullable): The website of the target user.

    • phone (string, nullable): The phone number of the target user.

    • mobile (string, nullable): The mobile number of the target user.

    • fax (string, nullable): The fax number of the target user.

    • vatId (string, nullable): The VAT ID of the target user.

    • address: An object containing the address details:

      • street (string): The street name.

      • houseNumber (string): The house number.

      • postalCode (string): The postal code.

      • city (string): The city name.

      • county (string): The county name.

      • country (string): The country name.

    • notificationPreferences: An object indicating the user's preferences for notifications:

      • email (boolean): Whether the user prefers to receive notifications via email.

      • phone (boolean): Whether the user prefers to receive notifications via phone.

      • postMail (boolean): Whether the user prefers to receive notifications via post mail.

  • event: An object containing event details related to the user:

    • id (string): The unique identifier of the event.

    • name (string): The name of the event.

    • year (string): The year of the event.

    • number (string): The event number.

    • slug (string): The URL slug for the event.

    • description (string, nullable): A description of the event.

Example Response:

Notes

• Ensure that the quicode provided is valid to receive the corresponding user profile information.

• The response will contain null values for any fields that are not applicable or not provided by the target user.