Friendship

Web API References for Friendship Service

Explore the list of Web APIs functions available for friendship service, including detailed descriptions and usage examples.

To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header.

Retrieves a list of friendship requests received by the current user based on the provided parameters.

get

Query parameters

skipinteger · int32Optional

limitinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/friendship/request

HTTPcURLJavaScriptPython

GET /api/table/services/friendship/request HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}

Retrieves a list of friendship requests sent by the current user based on the provided parameters.

get

Query parameters

skipinteger · int32Optional

limitinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/friendship/requesting

HTTPcURLJavaScriptPython

GET /api/table/services/friendship/requesting HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}

Accepts a friendship request based on the provided parameters.

post

Path parameters

requestIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/services/friendship/request/{requestId}

HTTPcURLJavaScriptPython

POST /api/table/services/friendship/request/{requestId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}

Rejects a friendship request based on the provided parameters.

delete

Path parameters

requestIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

delete

/api/table/services/friendship/request/{requestId}

HTTPcURLJavaScriptPython

DELETE /api/table/services/friendship/request/{requestId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}

Deletes a friendship with a specified user based on the provided parameters.

delete

Path parameters

targetUserIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

Responseboolean

delete

/api/table/services/friendship/{targetUserId}

HTTPcURLJavaScriptPython

DELETE /api/table/services/friendship/{targetUserId} HTTP/1.1
Host: 
Accept: */*

200

OK

true

Sends a friendship request to another user based on the provided parameters.

post

Body

application/jsontext/jsonapplication/*+json

target_user_idinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/services/friendship/request

HTTPcURLJavaScriptPython

POST /api/table/services/friendship/request HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "target_user_id": 1
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}

Rejects all pending friendship requests based on the provided parameters.

delete

Responses

200

OK

text/plainapplication/jsontext/json

delete

/api/table/services/friendship/request

HTTPcURLJavaScriptPython

DELETE /api/table/services/friendship/request HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "affected": 1
}

Retrieves a list of friendships for the current user based on the provided parameters.

get

Query parameters

skipinteger · int32Optional

limitinteger · int32Optional

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/friendship

HTTPcURLJavaScriptPython

GET /api/table/services/friendship HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-10-29T00:32:12.605Z",
      "last_login": "2025-10-29T00:32:12.605Z",
      "status": 1,
      "accepted_at": "2025-10-29T00:32:12.605Z"
    }
  ],
  "totalCount": 1
}