List Connection

List all current connection statuses with external or specified users.

List of requesting user's connection

get

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.

Query parameters

statusstring · enumOptional

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)

Possible values:

userIdsstringOptional

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 parameters

sessionTokenstringRequired

Session authentication token.

Responses

200

OK

application/json

Connection status between two users

userIdinteger · int64Optional

user id

Example: 769658112378

statusstring · enumOptional

Connection status between the requesting user and the request sender

Example: ACCEPTEDPossible values:

firstRequestedAtinteger · int64Optional

unix timestamp when the first request was made

Example: 1470018073812

updatedAtinteger · int64Optional

unix timestamp on the last updated date

Example: 1471018076255

requestCounterinteger · int32Optional

number of requests made

Example: 1

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not Found: Connection cannot be found.

application/json

500

Server error, see response body for further details.

application/json

get

/v1/connection/list

HTTPcURLJavaScriptPython

GET /pod/v1/connection/list HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Accept: */*

[
  {
    "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.