/friend | Elements Manual

get

Gets a specific friend using the ID of the friend.

Authorizations

Path parameters

friendIdanyrequired

Responses

application/json

objectoptional

application/json

get

GET /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

delete

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

Authorizations

Path parameters

friendIdanyrequired

Responses

application/json

objectoptional

application/json

delete

DELETE /api/rest/friend/{friendId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

offsetanyoptionalDefault: 0

countanyoptionalDefault: 20

searchanyoptional

Responses

application/json

objectoptional

application/json

get

GET /api/rest/friend HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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