by-user resource endpoint

URL: /users/<id>/relationships/@by-user/<id>.<format>

Supported Methods

GET Get a list of relationships that the selected user has with a single other user.

Query String Arguments

start-index
Index of the first item to return. The first item in the list has index 1.
max-results
Maximum number of items to return in the list response.

Resource Type

This endpoint returns an object of type List<Relationship>.

entries (array<Relationship>)
The items within the selected range.
totalResults (integer)
The total number of items in the whole list of which this object is a chunk.

Client Library Methods for PHP

Get a list of relationships that the selected user has with a single other user.
$tp->users->getRelationshipsByUser(array(

    # Required Parameters
    "id" => $id,
    "userId" => $userId,

    # Optional Parameters
    "limit" => $limit,
    "offset" => $offset,

))