List Connection

List all current connection statuses with external or specified users.

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.

GETyourpodURL.symphony.com/pod/v1/connection/list

Query parameters

Header parameters

Response

200400401403404500

OK

Body

application/json

userIdinteger (int64)

user id

Example: 769658112378

statusenum

Connection status between the requesting user and the request sender

Example: "ACCEPTED"

PENDING_INCOMINGPENDING_OUTGOINGACCEPTEDREJECTED

firstRequestedAtinteger (int64)

unix timestamp when the first request was made

Example: 1470018073812

updatedAtinteger (int64)

unix timestamp on the last updated date

Example: 1471018076255

requestCounterinteger (int32)

number of requests made

Example: 1

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/connection/list', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403404500

[
  {
    "userId": 769658112378,
    "status": "PENDING_OUTGOING",
    "firstRequestedAt": 1470018073812,
    "updatedAt": 1471018076255,
    "requestCounter": 1
  },
  {
    "userId": 7078106103809,
    "status": "ACCEPTED"
  }
]

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

• When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

• Pods from all users involved need to have crossPod enabled between them.

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.