Party

Web API References for Party Service

Explore the list of Web APIs functions available for party 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.

Edits the details of a specified party.

put

Path parameters

partyIdinteger · int32Required

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

put

/api/table/services/parties/{partyId}

HTTPcURLJavaScriptPython

PUT /api/table/services/parties/{partyId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "data": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Creates a new party based on the specified parameters.

post

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/services/parties

HTTPcURLJavaScriptPython

POST /api/table/services/parties HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "data": {
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": [
      "text"
    ],
    "channels": [
      "text"
    ],
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1,
    "created_at": "2025-10-29T01:03:00.462Z"
  }
}

Joins a user to a specified party.

post

Path parameters

partyIdinteger · int32Required

Body

application/jsontext/jsonapplication/*+json

teamstring | nullableOptional

channelsstring[] | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

post

/api/table/services/parties/{partyId}

HTTPcURLJavaScriptPython

POST /api/table/services/parties/{partyId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "team": "text",
  "channels": [
    "text"
  ]
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Retrieves a party by its unique identifier.

get

Path parameters

partyIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/parties/{partyId}

HTTPcURLJavaScriptPython

GET /api/table/services/parties/{partyId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1,
    "created_at": "2025-10-29T01:03:00.462Z"
  }
}

Retrieves a list of parties based on the specified parameters.

get

Query parameters

querystringOptionalDefault: ""

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 50

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/parties

HTTPcURLJavaScriptPython

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

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "max_member_count": 1,
      "is_private": true,
      "teams": "text",
      "channels": "text",
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "owner": 1,
      "created_at": "2025-10-29T01:03:00.462Z"
    }
  ],
  "totalCount": 1
}

Retrieves a list of members in a specified party.

get

Path parameters

partyIdinteger · int32Required

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 50

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/parties/{partyId}/members

HTTPcURLJavaScriptPython

GET /api/table/services/parties/{partyId}/members 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-29T01:03:00.462Z",
      "last_login": "2025-10-29T01:03:00.462Z",
      "role": 1,
      "status": 0,
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "channels": "text",
      "team": "text"
    }
  ],
  "totalCount": 1
}

Retrieves a list of members waiting for approval to join a specified party.

get

Path parameters

partyIdinteger · int32Required

Query parameters

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 50

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/parties/{partyId}/waiting

HTTPcURLJavaScriptPython

GET /api/table/services/parties/{partyId}/waiting HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "party": 1,
      "player": 1,
      "role": 1,
      "status": 0,
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "channels": "text",
      "team": "text"
    }
  ],
  "totalCount": 1
}

Removes a user from a specified party.

delete

Path parameters

partyIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

delete

/api/table/services/parties/{partyId}

HTTPcURLJavaScriptPython

DELETE /api/table/services/parties/{partyId} HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Retrieves a list of parties the user has subscribed to.

get

Query parameters

querystringOptionalDefault: ""

skipinteger · int32OptionalDefault: 0

limitinteger · int32OptionalDefault: 50

Responses

200

OK

text/plainapplication/jsontext/json

get

/api/table/services/parties/me

HTTPcURLJavaScriptPython

GET /api/table/services/parties/me HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "max_member_count": 1,
      "is_private": true,
      "teams": "text",
      "channels": "text",
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "owner": 1,
      "created_at": "2025-10-29T01:03:00.462Z"
    }
  ],
  "totalCount": 1
}