/friend

Previous/follower Next/google

Last updated 18 days ago

Gets a Specific Friend

get

Gets a specific friend using the ID of the friend.

Authorizations

Path parameters

friendIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/friend/{friendId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Path parameters

friendIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/friend/{friendId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Query parameters

offsetany · default: 0optional

countany · default: 20optional

searchanyoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/friend' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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