/friend

Gets a Specific Friend

get

Gets a specific friend using the ID of the friend.

Authorizations
AuthorizationstringRequired
Path parameters
friendIdanyRequired
Responses
get
/friend/{friendId}
GET /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Deletes a Friend

delete

Once a friend is deleted, re-creating a friend will set the friendship status to outgoing.

Authorizations
AuthorizationstringRequired
Path parameters
friendIdanyRequired
Responses
delete
/friend/{friendId}
DELETE /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Search Friends

get

Searches all friends in the system and returning the metadata for all matches against the given search filter.

Authorizations
AuthorizationstringRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
searchanyOptional
Responses
get
/friend
GET /api/rest/friend HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}
Previous/followerNext/google

Last updated