Skip to main content
Get Connection Status
Returns the connection status between the authenticated user and the specified user. The response shape varies depending on whether there is no connection, a pending request, an accepted connection, or a declined request.

Path Parameters

string
required
The Sublay user ID (UUID) of the other user.

Response

On success, returns HTTP 200. The shape depends on the connection state: No connection:
string
"none".
Pending request:
string
"pending".
string
"sent" if the authenticated user sent the request; "received" if they received it.
string
ID of the connection record.
string
ISO timestamp of when the request was sent.
Accepted (connected):
string
"connected".
string
ID of the connection record.
string
ISO timestamp of when the connection was accepted.
string
ISO timestamp of the original request.
Declined:
string
"declined".
string
"sent" or "received" — perspective of the authenticated user.
string
ID of the connection record.
string
ISO timestamp of when the request was declined.

Error Responses

See Also