Get connections

Get connections

This endpoint retrieves a filtered list of all outbound connections initiated by a specified user. It provides metadata about the connected users and the status of each connection.

• Purpose: To display all individuals a user has connected with, along with relevant metadata, connection statuses and basic user information.

Input Parameters

• Path Parameters:

  • initiatorUserId: The unique identifier of the user initiating the request.

• Query Parameters:

  • includeMeta: A boolean flag to include metadata in the response (set to true).

  • sort_by: Specifies the sorting order of the results; in this case, it sorts by status in descending order.

Response Structure

The response is a JSON object that contains the following structure:

• data:

  • _meta: Contains metadata about the response.

    • selection:

      • columns: An array of column objects detailing the properties of the data.

      • filters: An array of filter objects that provide options for filtering the results.

  • items: An array of connection objects, each containing:

    • initiatorEmail: Email of the user who initiated the connection.

    • initiatorUniqueId: Unique identifier for the initiator.

    • initiatorFirstName: First name of the initiator.

    • initiatorLastName: Last name of the initiator.

    • status: Current status of the connection.

    • encounter: Details of the encounter.

    • targetEmail: Email of the connected user.

    • targetUniqueId: Unique identifier for the connected user.

    • targetFirstName: First name of the connected user.

    • targetLastName: Last name of the connected user.

    • targetCompany: Company associated with the connected user.

    • fairevents_faireventNumber: Event number related to the connection.

    • fairevents_name: Name of the event.

    • fairevents_year: Year of the event.

    • fairevents_Id: Identifier for the event.

  • pagination: Contains pagination details.

    • page: Current page number.

    • size: Number of items per page.

    • total: Total number of items available.

    • pages: Total number of pages.

This endpoint adheres to our standards for selections.