List Connection

List all current connection statuses with external or specified users.
get
https://yourpodURL.symphony.com/pod
/v1/connection/list
List of requesting user's connection

This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those in which the requesting user is the inivtee) By default, if you haven't specified the connection status to filter on, this call will only return results for both "pending_incoming" and "pending_outgoing". You can optionally filter by userIds to further restrict the results of a specific connection status. If the users are in the same private pod, the users have an implicit connection status of "accepted". Those users will not be returned in the response if you don't specify the connection status as "accepted" (default is "pending") and the explicit userIds in the request.

Parameters
Query
status
string
Filter the connection list based on the connection status. The connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all (all of the above)
userIds
string
The userIds parameter should be specified as a comma delimited list of user ids and can be used to restrict the results of a specific connection. Note that this is particularly important if the caller intends to retrieve results for implicit connection (user within the same pod). Implicit connections will not be included in the response if userId is not provided.
Header
sessionToken*
string
Session authentication token.
Responses
200: OK
OK
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
404: Not Found
Not Found: Connection cannot be found.
500: Internal Server Error
Server error, see response body for further details.
This endpoint retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those in which the requesting user is the invitee). By default, if you have not specified the connection status to filter on, this call will only return results for both PENDING_INCOMING and PENDING_OUTGOING. You can optionally filter by userIds to further restrict the results of a specific connection status. If the users are in the same private pod, the users have an implicit connection status of ACCEPTED. Those users will not be returned in the response if you do not specify the connection status as ACCEPTED (default is "pending") and the explicit userIds in the request.

📘 Note

Connection Status

Currently, there are four possible connection status:
  • PENDING_INCOMING: The specified user requested to connect with the calling user.
  • PENDING_OUTGOING: The calling user requested to connect with the specified user.
  • ACCEPTED: The two users are connected.
  • REJECTED: The two users are not connected.
Last modified 2mo ago